struct CHANNEL_INSTANCE

A structure defined by the profile API for managing a channel-instance.

Documentation

A structure defined by the profile API for managing a channel-instance.

This is an opaque structure, and is the dual of the profile-instance structure.

Unless otherwise noted, all fields should be considered read-only by the profile.

Fields:

conn - A pointer to the associated connection structure.
channel_number - The associated channel number.
profile_registration - A pointer to the profile-registration structure used to instantiate this channel.
profile - A pointer to the associated profile-instance structure.
status - The channel's current status, one of:

• INST_STATUS_STARTING
• INST_STATUS_CLOSING
• INST_STATUS_TUNING
• INST_STATUS_EXIT
• INST_STATUS_RUNNING

outbound - A pointer to the chan0_msg structure sent for for a pending start or close channel request. (This structure isn't user-documented, don't ask.)
inbound - A pointer to the chan0_msg structure received for for a pending start or close channel request. (This structure isn't user-documented, don't ask; however, see pro_start_indication for the exception that proves the rule, i.e., to see the one place you may need to access this structure.)
app_sr_callback - A pointer to a callback in the aplication which is called when a start request has been completed. This is provided as an argument to bp_start_request.
app_cr_callback - A pointer to a callback in the aplication which is called when a close request has been completed. This is provided as an argument to bpc_close_request.
cb_client_data - A user-supplied pointer given as an argument to either bp_start_request or bpc_close_request.
diagnostic - A pointer to a diagnostic structure supplied when the callback calls either bpc_start_response or bpc_close_response.
commit - Keeps track of success/failure when processing a multistage close request.
user_sem1 - A semaphore used by the wrapper.
user_sem2 - A semaphore used by the wrapper.
tid - Thread information used by the wrapper.
lmem - Memory information used by the wrapper.

Home Alphabetic index