extern struct diagnostic* bpc_close_request

(struct CHANNEL_INSTANCE* inst,
  long message_number,
  long code,
  char* language,
  char* message,
  close_request_callback app_cr_callback,
  void* client_data)

Initiates a request to close a channel.

Documentation

Initiates a request to close a channel.

If the request can't be processed, a diagnostic structure is returned explaining the reason (which should subsequently be destroyed by calling bp_diagnostic_destroy).

Otherwise, the profile's pro_close_indication callback is invoked to ask permission. If denied, the callback and the profile's pro_close_confirmation callback is invoked to indicate this.

Otherwise, later on the callback and the profile's pro_close_confirmation callback will be invoked indicating whether the channel was closed or not.

Parameters:

channel - A pointer to the channel-instance.
message_number - The message number to use on the request or BLU_CHAN0_MSGNO_DEFAULT.
message_number - Message number on channel 0 to send. -1 means use next.
code - The value to use for the code attribute of the <close> element. Typically, 200 for "OK". Consult Section 8 of RFC 3080 for an (incomplete) list.
language - The value to use for the xml:lang attribute of the <close> element.
message - A textual message corresponding to the code parameter.
app_closet_request_callback - A callback to be initiated when the outcome is known.
client_data - A user-supplied pointer.

Returns:

On failure, a pointer to a diagnostic structure explaining the reason (which should subsequently be destroyed by calling bp_diagnostic_destroy).

Home Alphabetic index