HP-UX C SIP Stack Programmer's Guide (Novembery 2007)

294 HP-UX C SIP Stack Programmer’s Guide
Connection API
RvSipTransportConnectionHandle
Defines a connection handle. You receive this handle when creating a new client
connection using the RvSipTransportMgrCreateConnection() function. Or, you
receive it through the RvSipTransportConnectionCreatedEv() callback when the
SIP Stack creates a new server connection.
CONNECTION API The Transport API contains a set of functions and function callbacks that enable
you to initialize new connections, set or examine connection parameters,
connect and disconnect connections, and attach or detach from connections.
CONNECTION
P
ARAMETERS
A connection holds the following parameters:
Local and Remote addresses
A Transport connection is opened from a specific local address to a specific
remote address. The local and remote address parameters indicate these
addresses. Each address includes the IP, port and address type (IPv4 or IPv6).
The local and remote addresses along with the connection transport type provide
the connection key. The connection is inserted into the connection hash
according to this key and can be located and used by different SIP Stack objects.
Transport Type
Indicates whether the connection is a TCP or TLS connection. The transport
type is part of the connection key.
Num Of Owners
As explained above, a connection can have several owners. The connection
notifies each of its owners about connection events. As long as a client
connection has owners, the connection remains connected. When the last owner
detaches from the connection, the connection disconnects. This parameter holds
the number of owners currently attached to the connection.
Connection State
Indicates the state of the TCP session setup between two SIP User Agents. You
can only access the state parameter with a Get function and it is not modifiable.
Is Client
Indicates whether the connection is a TCP client or server.