struct BP_CONNECTION

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

[more]#define INST_ROLE_INITIATOR
BP_CONNECTION was initiated by the local peer
[more]#define INST_ROLE_LISTENER
BP_CONNECTION was initiated by the remote peer
[more]#define INST_STATUS_STARTING
BP_CONNECTION is in the process of starting a new channel, possibly channel 0
[more]#define INST_STATUS_CLOSING
BP_CONNECTION is in the process of closing an existing channel
[more]#define INST_STATUS_TUNING
BP_CONNECTION is starting a tuning reset
[more]#define INST_STATUS_EXIT
BP_CONNECTION is trying to shut down
[more]#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.

o#define INST_ROLE_INITIATOR
BP_CONNECTION was initiated by the local peer

o#define INST_ROLE_LISTENER
BP_CONNECTION was initiated by the remote peer

o#define INST_STATUS_STARTING
BP_CONNECTION is in the process of starting a new channel, possibly channel 0

o#define INST_STATUS_CLOSING
BP_CONNECTION is in the process of closing an existing channel

o#define INST_STATUS_TUNING
BP_CONNECTION is starting a tuning reset

o#define INST_STATUS_EXIT
BP_CONNECTION is trying to shut down

o#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:
channel_instance - A pointer to the channels known (started or being started) on this connection.

Home Alphabetic index



This page was generated with the help of DOC++.