SocketState Class Reference

Properties
byte []	AckBuffer [get, set]
byte []	ReadBuffer [get, set]
List< byte[]>	ReadBuffers [get, set]
int	TotalLength [get, set]

Detailed Description

This class contains the response received from the PBX and state information about the exchange with the PBX that is used internally by CSTADLL.

Property Documentation

AckBuffer

byte [] AckBuffer

getset

Contains the first response from the PBX for situations where the PBX sends multiple response messages (e.g., Get Switching Function Devices). The data messages that are sent after this ack will be in ReadBuffers.

ReadBuffer

byte [] ReadBuffer

getset

Contains the bytes most recently read from the socket. This buffer will be filled in bit by bit as the message is read.

Referenced by PBXSession.Close(), uaXMLed4.Invite(), PBXSession.Open(), PBXSession.SendACSEMessage(), PBXSession.SendXMLMessage(), PBXSession.SendXMLSession(), and GenericXMLed4.StartSession().

ReadBuffers

List<byte[]> ReadBuffers

getset

Contains multiple collections of bytes read from the socket. This array is used for situations where a response to a message comes in multiple segments (e.g., Get Switching Function Devices). For these situations the immediate response will be in AckBuffer.

TotalLength

int TotalLength

getset

The total length of a complete message received from the PBX. This is also used as an offset into the read buffer so we can build the message as it's received.

Referenced by PBXSession.Close(), uaXMLed4.Invite(), PBXSession.Open(), PBXSession.SendACSEMessage(), PBXSession.SendXMLMessage(), PBXSession.SendXMLSession(), and GenericXMLed4.StartSession().