Objective Systems, Inc.  

Channel Management


Functions

EXTERN int ooCreateH323Listener (void)
 This function is used to create a listener for incoming calls.
EXTERN int ooCreateH245Listener (struct OOH323CallData *call)
 This function is used to create a listener for incoming H.245 connections.
EXTERN int ooCloseH245Listener (struct OOH323CallData *call)
 This function is used to close an H245 listener for a call.
EXTERN int ooAcceptH225Connection (void)
 This function is used to accept incoming H.225 connections.
EXTERN int ooAcceptH245Connection (struct OOH323CallData *call)
 This function is used to accept an incoming H.245 connection.
EXTERN int ooCreateH225Connection (struct OOH323CallData *call)
 This function is used to create an H.225 connection to the remote end point.
EXTERN int ooCreateH245Connection (struct OOH323CallData *call)
 This function is used to setup an H.245 connection with the remote endpoint for control negotiations.
EXTERN int ooCloseH225Connection (struct OOH323CallData *call)
 This function is used to close an H.225 connection.
EXTERN int ooCloseH245Connection (struct OOH323CallData *call)
 This function is used to close an H.245 connection for a call.
EXTERN int ooMonitorChannels (void)
 This function is used to start monitoring channels for the calls.
EXTERN int ooStopMonitorCalls (void)
 This function is called to stop the monitor channels event loop.
EXTERN int ooH2250Receive (struct OOH323CallData *call)
 This function is used to receive an H.2250 message received on a calls H.225 channel.
EXTERN int ooH245Receive (struct OOH323CallData *call)
 This function is used to receive an H.245 message received on a calls H.245 channel.
EXTERN int ooSendH225Msg (struct OOH323CallData *call, struct Q931Message *msg)
 This function is used to enqueue an H.225 message into an outgoing queue for the call.
EXTERN int ooSendMsg (struct OOH323CallData *call, int type)
 This function is used to Send a message on the channel, when channel is available for write.
EXTERN int ooOnSendMsg (struct OOH323CallData *call, int msgType, int tunneledMsgType, int associatedChan)
 This function is called after a message is sent on the call's channel.
EXTERN OOBOOL ooChannelsIsConnectionOK (OOH323CallData *call, OOSOCKET sock)
 This function is used to check the status of tcp connection.
EXTERN int ooCreateCmdListener ()
 This function creates a command listener.
EXTERN int ooAcceptCmdConnection ()
 This function is used to accept an incoming connection request for command channel.
EXTERN int ooCreateCmdConnection ()
 This function is used to setup a command connection with the main stack thread.
EXTERN int ooCloseCmdConnection ()
 This function is used to close a command channel setup with the stack thread.
EXTERN int ooWriteStackCommand (OOStackCommand *cmd)
 This function is used by stack api to write stack commands to command channel.
EXTERN int ooProcessStackCommand (OOStackCommand *pcmd)
 This function is used to process a stack command received on the command channel.

Function Documentation

EXTERN int ooCreateH323Listener ( void   ) 

This function is used to create a listener for incoming calls.

Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooCreateH245Listener ( struct OOH323CallData call  ) 

This function is used to create a listener for incoming H.245 connections.

Parameters:
call Pointer to call for which H.245 listener has to be created
Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooCloseH245Listener ( struct OOH323CallData call  ) 

This function is used to close an H245 listener for a call.

Parameters:
call Pointer to call for which H245 Listener has to be closed.
Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooAcceptH225Connection ( void   ) 

This function is used to accept incoming H.225 connections.

Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooAcceptH245Connection ( struct OOH323CallData call  ) 

This function is used to accept an incoming H.245 connection.

Parameters:
call Pointer to a call for which H.245 connection request has arrived.
Returns:
OO_OK, on succes. OO_FAILED, on failure.

EXTERN int ooCreateH225Connection ( struct OOH323CallData call  ) 

This function is used to create an H.225 connection to the remote end point.

Parameters:
call Pointer to the call for which H.225 connection has to be setup.
Returns:
OO_OK, on succes. OO_FAILED, on failure.

EXTERN int ooCreateH245Connection ( struct OOH323CallData call  ) 

This function is used to setup an H.245 connection with the remote endpoint for control negotiations.

Parameters:
call Pointer to call for which H.245 connection has to be setup.
Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooCloseH225Connection ( struct OOH323CallData call  ) 

This function is used to close an H.225 connection.

Parameters:
call Pointer to the call for which H.225 connection has to be closed.
Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooCloseH245Connection ( struct OOH323CallData call  ) 

This function is used to close an H.245 connection for a call.

Parameters:
call Pointer to call for which H.245 connection has to be closed.
Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooMonitorChannels ( void   ) 

This function is used to start monitoring channels for the calls.

It has an infinite loop which uses select to monitor various channels.

EXTERN int ooStopMonitorCalls ( void   ) 

This function is called to stop the monitor channels event loop.

It cleans up all the active calls before stopping the monitor.

Returns:
OO_OK, on success. OO_FAILED, on failure

EXTERN int ooH2250Receive ( struct OOH323CallData call  ) 

This function is used to receive an H.2250 message received on a calls H.225 channel.

It receives the message, decodes it and calls 'ooHandleH2250Message' to process the message.

Parameters:
call Pointer to the call for which the message has to be received.
Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooH245Receive ( struct OOH323CallData call  ) 

This function is used to receive an H.245 message received on a calls H.245 channel.

It receives the message, decodes it and calls 'ooHandleH245Message' to process it.

Parameters:
call Pointer to the call for which the message has to be received.
Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooSendH225Msg ( struct OOH323CallData call,
struct Q931Message msg 
)

This function is used to enqueue an H.225 message into an outgoing queue for the call.

Parameters:
call Pointer to call for which message has to be enqueued.
msg Pointer to the H.225 message to be sent.
Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooSendMsg ( struct OOH323CallData call,
int  type 
)

This function is used to Send a message on the channel, when channel is available for write.

Parameters:
call Pointer to call for which message has to be sent.
type Type of the message.
Returns:
OO_OK, on success. OO_FAILED, on failure.

EXTERN int ooOnSendMsg ( struct OOH323CallData call,
int  msgType,
int  tunneledMsgType,
int  associatedChan 
)

This function is called after a message is sent on the call's channel.

It can be used to some followup action after message has been sent.

Parameters:
call Pointer to call for which message has been sent.
msgType Type of message
tunneledMsgType If this message is carrying a tunneled message, then type of the tunneled message.
associatedChan The channel number associated with the message sent, or tunneled message. 0, if no channel is associated.
Returns:
OO_OK, on success. OO_FAILED, on failure

EXTERN OOBOOL ooChannelsIsConnectionOK ( OOH323CallData call,
OOSOCKET  sock 
)

This function is used to check the status of tcp connection.

Parameters:
call Handle to the call to which connection belongs.
sock Connected socket.
Returns:
True if connection is ok, false otherwise.

EXTERN int ooCreateCmdListener (  ) 

This function creates a command listener.

This is nothing but a tcp socket in listen mode waiting for incoming connection on which the stack thread will receive commands.

Returns:
OO_OK, on success; OO_FAILED, on failure

EXTERN int ooAcceptCmdConnection (  ) 

This function is used to accept an incoming connection request for command channel.

Returns:
OO_OK, on success; OO_FAILED, on failure

EXTERN int ooCreateCmdConnection (  ) 

This function is used to setup a command connection with the main stack thread.

The application commands are sent over this connection to stack thread.

Returns:
OO_OK, on success; OO_FAILED, on failure

EXTERN int ooCloseCmdConnection (  ) 

This function is used to close a command channel setup with the stack thread.

Returns:
OO_OK, on success; OO_FAILED, on failure

EXTERN int ooWriteStackCommand ( OOStackCommand cmd  ) 

This function is used by stack api to write stack commands to command channel.

Returns:
OO_OK, on success; OO_FAILED, on failure

EXTERN int ooProcessStackCommand ( OOStackCommand pcmd  ) 

This function is used to process a stack command received on the command channel.

Returns:
OO_OK, on success; OO_FAILED, on failure


This file was last modified on 28 May 2010.
Objective Open H.323 Stack, 0.9.1