Join us on LinkedIn Read our Blog

Isode SOM API

Queue Access Callback Functions


Typedefs

typedef void SOMQueueCallback (struct SOMSession *session, void *ophandle, void *clientdata, int status)
 Prototype for callback for queue operation completion.
typedef void SOMQchannelCallback (struct SOMSession *session, void *ophandle, void *clientdata, struct SOMQchannel *channel)
 Prototype for callback for reporting channel object.
typedef void SOMQmtaCallback (struct SOMSession *session, void *ophandle, void *clientdata, struct SOMQmta *mta)
 Prototype for callback for reporting mta object.
typedef void SOMQmessageCallback (struct SOMSession *session, void *ophandle, void *clientdata, struct SOMQmessage *message)
 Prototype for callback for reporting message object.

Functions

int SOMQueueSetCallback (struct SOMSession *session, SOMQueueCallback *callback, SOMQueueCallback **oldvalue)
 Set the Queue callback function for this session.
int SOMQueueSetChannelCallback (struct SOMSession *session, SOMQchannelCallback *callback, SOMQchannelCallback **oldvalue)
 Set the callback function for channel objects for this session.
int SOMQueueSetMtaCallback (struct SOMSession *session, SOMQmtaCallback *callback, SOMQmtaCallback **oldvalue)
 Set the callback function for Mtas for this session.
int SOMQueueSetMessageCallback (struct SOMSession *session, SOMQmessageCallback *callback, SOMQmessageCallback **oldvalue)
 Set the callback function for messages for this session.

Detailed Description

Description of the function calls for viewing and monitoring log files.

Typedef Documentation

typedef void SOMQueueCallback(struct SOMSession *session, void *ophandle, void *clientdata, int status)

Prototype for callback for queue operation completion.

Parameters:
session [in] Pointer to address of session object
ophandle [in] Data associated with operation
clientdata [in] Data associated with session
status [in] Status for the operation
Returns:
no return value

Definition at line 58 of file queue.h.

typedef void SOMQchannelCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMQchannel *channel)

Prototype for callback for reporting channel object.

Parameters:
session [in] Pointer to address of session object
ophandle [in] Data associated with operation
clientdata [in] Data associated with session
status [in] Status for the operation
channel [in] Pointer to opaque channel object
Returns:
no return value
The channel object only exists for the duration of this callback.

Definition at line 75 of file queue.h.

typedef void SOMQmtaCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMQmta *mta)

Prototype for callback for reporting mta object.

Parameters:
session [in] Pointer to address of session object
ophandle [in] Data associated with operation
clientdata [in] Data associated with session
status [in] Status for the operation
mta [in] Pointer to opaque mta object
Returns:
no return value
The mta object only exists for the duration of this callback.

Definition at line 93 of file queue.h.

typedef void SOMQmessageCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMQmessage *message)

Prototype for callback for reporting message object.

Parameters:
session [in] Pointer to address of session object
ophandle [in] Data associated with operation
clientdata [in] Data associated with session
status [in] Status for the operation
message [in] Pointer to opaque message object
Returns:
no return value
The message object only exists for the duration of this callback.

Recipients are accessed through this object.

Definition at line 113 of file queue.h.

Function Documentation

int SOMQueueSetCallback ( struct SOMSession *  session,
SOMQueueCallback *  callback,
SOMQueueCallback **  oldvalue 
)

Set the Queue callback function for this session.

Parameters:
session [in] Pointer to address of session object
callback [in] Address of callback function
oldvalue [out] Pointer to location for previous value of callback function
Returns:
zero on success; non-zero on error
callback may be NULL to clear the callback function oldvalue may be NULL, in which case the previous value is not returned

int SOMQueueSetChannelCallback ( struct SOMSession *  session,
SOMQchannelCallback *  callback,
SOMQchannelCallback **  oldvalue 
)

Set the callback function for channel objects for this session.

Parameters:
session [in] Pointer to address of session object
callback [in] Address of callback function
oldvalue [out] Pointer to location for previous value of callback function
Returns:
zero on success; non-zero on error
callback may be NULL to clear the callback function oldvalue may be NULL, in which case the previous value is not returned

int SOMQueueSetMtaCallback ( struct SOMSession *  session,
SOMQmtaCallback *  callback,
SOMQmtaCallback **  oldvalue 
)

Set the callback function for Mtas for this session.

Parameters:
session [in] Pointer to address of session object
callback [in] Address of callback function
oldvalue [out] Pointer to location for previous value of callback function
Returns:
zero on success; non-zero on error
callback may be NULL to clear the callback function oldvalue may be NULL, in which case the previous value is not returned

int SOMQueueSetMessageCallback ( struct SOMSession *  session,
SOMQmessageCallback *  callback,
SOMQmessageCallback **  oldvalue 
)

Set the callback function for messages for this session.

Parameters:
session [in] Pointer to address of session object
callback [in] Address of callback function
oldvalue [out] Pointer to location for previous value of callback function
Returns:
zero on success; non-zero on error
callback may be NULL to clear the callback function oldvalue may be NULL, in which case the previous value is not returned