struct BP_CONNECTION

A structure defined by the Wrapper API for managing a connection.

#define INST_ROLE_INITIATOR

BP_CONNECTION was initiated by the local peer

#define INST_ROLE_LISTENER

BP_CONNECTION was initiated by the remote peer

#define INST_STATUS_STARTING

BP_CONNECTION is in the process of starting a new channel, possibly channel 0

#define INST_STATUS_CLOSING

BP_CONNECTION is in the process of closing an existing channel

#define INST_STATUS_TUNING

BP_CONNECTION is starting a tuning reset

#define INST_STATUS_EXIT

BP_CONNECTION is trying to shut down

#define INST_STATUS_RUNNING

BP_CONNECTION isn't in any other state

Documentation

A structure defined by the Wrapper API for managing a connection.

The code that manages the BP_CONNECTION structure is called the wrapper. Its responsibilities include mapping of channel numbers to profile-instances, mapping of URIs to profile registrations, and invoking profiles at the appropriate time as messages arrive on the socket. It also manages input/output threads, profile threads, and locks to prevent conflicts. It manages tuning resets and graceful termination of sessions and controls. Finally, the wrapper indirectly manages any information that is inter-channel in nature, such as the SASL identity, the TLS encryption keys, and any other information a profile might wish to make available to other profiles.

#define INST_ROLE_INITIATOR

BP_CONNECTION was initiated by the local peer

#define INST_ROLE_LISTENER

BP_CONNECTION was initiated by the remote peer

#define INST_STATUS_STARTING

BP_CONNECTION is in the process of starting a new channel, possibly channel 0

#define INST_STATUS_CLOSING

BP_CONNECTION is in the process of closing an existing channel

#define INST_STATUS_TUNING

BP_CONNECTION is starting a tuning reset

#define INST_STATUS_EXIT

BP_CONNECTION is trying to shut down

#define INST_STATUS_RUNNING

BP_CONNECTION isn't in any other state

Fields:

role - Either INST_ROLE_INITIATOR or INST_ROLE_LISTENER
mode - Either "plaintext" or "encrypted"
status - The connection's current status, one of:

• INST_STATUS_STARTING
• INST_STATUS_CLOSING
• INST_STATUS_TUNING
• INST_STATUS_EXIT
• INST_STATUS_RUNNING

channel_instance - A pointer to the channels known (started or being started) on this connection.

Home Alphabetic index