Objective Systems, Inc.  

Stack Control Commands


Data Structures

struct  OOStackCommand
 This structure is used to queue a stack command for processing in the event handler loop. More...

Defines

#define ooCommand   OOStackCommand;

Enumerations

enum  OOStkCmdStat {
  OO_STKCMD_SUCCESS,
  OO_STKCMD_MEMERR,
  OO_STKCMD_INVALIDPARAM,
  OO_STKCMD_WRITEERR,
  OO_STKCMD_CONNECTIONERR
}
 This is an enumeration of Stack Command return codes.
enum  OOStackCmdID {
  OO_CMD_NOOP,
  OO_CMD_MAKECALL,
  OO_CMD_ANSCALL,
  OO_CMD_FWDCALL,
  OO_CMD_HANGCALL,
  OO_CMD_SENDDIGIT,
  OO_CMD_MANUALRINGBACK,
  OO_CMD_STOPMONITOR
}
 This is an enumeration of stack command codes. More...

Functions

EXTERN OOStkCmdStat ooMakeCall (const char *dest, char *callToken, size_t bufsiz, ooCallOptions *opts)
 This function is used by an application to place a call.
EXTERN OOStkCmdStat ooManualRingback (const char *callToken)
 This function is used to send a manual ringback message (alerting message) for a call.
EXTERN OOStkCmdStat ooAnswerCall (const char *callToken)
 This function is used to answer a call.
EXTERN OOStkCmdStat ooForwardCall (const char *callToken, char *dest)
 This function is used to forward an existing call to third party.
EXTERN OOStkCmdStat ooHangCall (const char *callToken, OOCallClearReason reason)
 This function is used by an user application to terminate a call.
EXTERN OOStkCmdStat ooSendDTMFDigit (const char *callToken, const char *alpha)
 This command function can be used by an user application to send a DTMF sequence using H.245 UserInputIndication message.
EXTERN OOStkCmdStat ooStopMonitor (void)
 This function is used by the user application to stop stack thread.
EXTERN const char * ooGetStkCmdStatusCodeTxt (OOStkCmdStat stat)
 This function is used by application to obtain the text description for failure of tsack command.

Enumeration Type Documentation

This is an enumeration of stack command codes.

Enumerator:
OO_CMD_MAKECALL  Make call
OO_CMD_ANSCALL  Answer call
OO_CMD_FWDCALL  Forward call
OO_CMD_HANGCALL  Terminate call
OO_CMD_SENDDIGIT  Send dtmf
OO_CMD_MANUALRINGBACK  Send Alerting - ringback
OO_CMD_STOPMONITOR  Stop the event monitor

Definition at line 60 of file ooStackCmds.h.


Function Documentation

EXTERN OOStkCmdStat ooMakeCall ( const char *  dest,
char *  callToken,
size_t  bufsiz,
ooCallOptions opts 
)

This function is used by an application to place a call.

Parameters:
dest Call Destination - IP:port / alias
callToken Pointer to a buffer in which callToken will be returned
bufsiz Size of the callToken buffer passed.
opts These are call specific options and if passed a non-null value, will override global endpoint options.
Returns:
Returns OOStkCmdStat value indication success or failure.

EXTERN OOStkCmdStat ooManualRingback ( const char *  callToken  ) 

This function is used to send a manual ringback message (alerting message) for a call.

Effective only when manual-ringback is enabled.

Parameters:
callToken Unique token for the call.
Returns:
Returns OOStkCmdStat value indication success or failure.

EXTERN OOStkCmdStat ooAnswerCall ( const char *  callToken  ) 

This function is used to answer a call.

Parameters:
callToken Unique token for the call
Returns:
Returns OOStkCmdStat value indication success or failure.

EXTERN OOStkCmdStat ooForwardCall ( const char *  callToken,
char *  dest 
)

This function is used to forward an existing call to third party.

Parameters:
callToken Unique token for the call.
dest Address to which the call has to be forwarded. Can be IP:PORT or alias.
Returns:
Returns OOStkCmdStat value indication success or failure.

EXTERN OOStkCmdStat ooHangCall ( const char *  callToken,
OOCallClearReason  reason 
)

This function is used by an user application to terminate a call.

Parameters:
callToken The uinque token for the call.
reason Reason for hanging call.
Returns:
Returns OOStkCmdStat value indication success or failure.

EXTERN OOStkCmdStat ooSendDTMFDigit ( const char *  callToken,
const char *  alpha 
)

This command function can be used by an user application to send a DTMF sequence using H.245 UserInputIndication message.

Parameters:
callToken Unique token for the call
alpha Alphanumeric string reperesenting dtmf sequence
Returns:
Returns OOStkCmdStat value indication success or failure.

EXTERN OOStkCmdStat ooStopMonitor ( void   ) 

This function is used by the user application to stop stack thread.

Returns:
Returns OOStkCmdStat value indication success or failure.

EXTERN const char* ooGetStkCmdStatusCodeTxt ( OOStkCmdStat  stat  ) 

This function is used by application to obtain the text description for failure of tsack command.

Parameters:
stat Status code returned by stack command api.
Returns:
Text description corresponding to the code.


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