PBXSessionHelper Class Reference

List of all members.

Public Member Functions
delegate void	AsyncCallback (byte[] asyncData)
Static Public Member Functions
static void	Close ()
static void	Init (string pbxSystem, int port)
static void	Open ()
static void	SendMessage (string messageType, byte[] message, int messageLength, Asn1Choice invokeId)
static void	SendMessage (byte[] message, int messageLength, Asn1Choice invokeId)
static SocketState	WaitForACSEResponse ()
static SocketState	WaitForROSEResponse (Asn1Choice invokeId)
Properties
static AsyncCallback	ClientCallback [get, set]
static bool	DebugMode [get, set]
static bool	LoggingEnabled [get, set]
static string	LoggingFolder [get, set]

---

Detailed Description

Manages the communication with the PBX. This class is a static helper class that allows a client of the DLL to communicate with a single PBX.

---

Member Function Documentation

delegate void AsyncCallback

(

byte[]

asyncData

)

Declaration of a callback function to be invoked when an asynchronous message is received, such as from a monitor session.

Parameters:

asyncData

The data received asynchronously from the PBX.

static void Close

(

)

[static]

Terminates the session to the PBX. This method can be used to terminate sessions with PBX devices that don't accept ACSE release association requests.

static void Init	(	string	pbxSystem,
		int	port
	)			[static]

Initializes the PBX Session.

Parameters:

	pbxSystem	The name or IP address of the PBX system.
	port	The port on the PBX system to which the client is connecting.

static void Open

(

)

[static]

This method can be used to establish communication with a PBX device before any messages are actually sent to the device.

static void SendMessage	(	string	messageType,
		byte[]	message,
		int	messageLength,
		Asn1Choice	invokeId
	)			[static]

This method sends a message to the PBX using TCP/IP.

Parameters:

	messageType	A string token to help identify the message in the CSTADLL log file.
	message	Byte array containing the encoded message to send.
	messageLength	The length of the encoded message.
	invokeId	The invoke id object from the message's ROSE header. This parameter is cast up to Asn1Choice since this method is phase-independent, and the InvokeId classes for all three phases derive from the Asn1Choice class in the ASN1C C# runtime.

static void SendMessage	(	byte[]	message,
		int	messageLength,
		Asn1Choice	invokeId
	)			[static]

This method sends a message to the PBX using TCP/IP.

Parameters:

	message	Byte array containing the encoded message to send.
	messageLength	The length of the encoded message.
	invokeId	The invoke id object from the message's ROSE header. This parameter is cast up to Asn1Choice since this method is phase-independent, and the InvokeId classes for all three phases derive from the Asn1Choice class in the ASN1C C# runtime.

static SocketState WaitForACSEResponse

(

)

[static]

This method waits for a response to an ACSE message. ACSE messages do not have the ROSE header.

Returns:

A SocketState instance that contains the response that comes back from the PBX.

static SocketState WaitForROSEResponse

(

Asn1Choice

invokeId

)

[static]

This method waits for a response to a CSTA message sent with a ROSE header.

Parameters:

invokeId

The invoke id object that was encoded into the ROSE header. This is used to match received messages back to the sending message. The parameter is cast up to Asn1Choice because this method is phase-independent, and the InvokeId classes for all three phases derive from the Asn1Choice class in the ASN1C C# runtime.

Returns:

A SocketState instance that contains the response that comes back from the PBX.

---

Property Documentation

AsyncCallback ClientCallback [static, get, set]

Holds a reference to an asynchronous callback function. This function will be invoked if data is received asynchronously from the PBX, such as from a monitor operation.

bool DebugMode [static, get, set]

Enables behavior that facilitates debugging of the CSTADLL software. This property is most likely useful only to Objective Systems staff.

bool LoggingEnabled [static, get, set]

Determines whether logging of traffic between the client and the PBX will be done.

string LoggingFolder [static, get, set]

Specifies a folder to receive the log file. If not specified, the log file will go into whatever folder the calling .exe resides in.