Store Access Callback Functions

Description of the function calls for monitoring the Message Store. More...

Typedefs
typedef void	SOMMSStoreCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMMSData *data, int status, const char *errstring)
	Prototype for callback for store operation completion. More...
typedef void	SOMMSStoreMonitorCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMMSData *data, int status, const char *datap, size_t dlen)
	Prototype for callback for store monitoring. More...
typedef void	SOMMSStoreMailboxesCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMMSData *data, int status)
	Prototype for callback for store mailboxes operation completion. More...
typedef void	SOMMSStoreConnectionsCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMMSData *data, int status)
	Prototype for callback for store connections operation completion. More...
typedef void	SOMMSStoreMessagesCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMMSData *data, int status)
	Prototype for callback for store messages operation completion. More...
typedef void	SOMMSConnectionCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMMSConnection *con, int status)
	Prototype for callback for reporting connection object. More...
typedef void	SOMMSMailboxCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMMSMailbox *mbx, int status)
	Prototype for callback for reporting mailbox object. More...
typedef void	SOMMSMessageCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMMSMessage *message, int status)
	Prototype for callback for reporting message object. More...

Detailed Description

Description of the function calls for monitoring the Message Store.

Typedef Documentation

SOMMSStoreCallback

typedef void SOMMSStoreCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMMSData *data, int status, const char *errstring)

Prototype for callback for store operation completion.

Parameters

session	[in] Pointer to address of session object
ophandle	[in] Data associated with operation
clientdata	[in] Data associated with session
data	[in] Internal SOM data handle
status	[in] Status for the operation
errstring	[in] Supplementary error text

Returns

no return value

Definition at line 58 of file store.h.

SOMMSStoreMonitorCallback

typedef void SOMMSStoreMonitorCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMMSData *data, int status, const char *datap, size_t dlen)

Prototype for callback for store monitoring.

Parameters

session	[in] Pointer to address of session object
ophandle	[in] Data associated with operation
clientdata	[in] Data associated with session
data	[in] Internal SOM data handle
status	[in] Status for the operation
datap	[in] Data pointer
dlen	[in] Data length

Returns

no return value

Definition at line 76 of file store.h.

SOMMSStoreMailboxesCallback

typedef void SOMMSStoreMailboxesCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMMSData *data, int status)

Prototype for callback for store mailboxes operation completion.

Parameters

session	[in] Pointer to address of session object
ophandle	[in] Data associated with operation
clientdata	[in] Data associated with session
data	[in] Internal SOM data handle
status	[in] Status for the operation

Returns

no return value

Definition at line 95 of file store.h.

SOMMSStoreConnectionsCallback

typedef void SOMMSStoreConnectionsCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMMSData *data, int status)

Prototype for callback for store connections operation completion.

Parameters

session	[in] Pointer to address of session object
ophandle	[in] Data associated with operation
clientdata	[in] Data associated with session
data	[in] Internal SOM data handle
status	[in] Status for the operation

Returns

no return value

Definition at line 111 of file store.h.

SOMMSStoreMessagesCallback

typedef void SOMMSStoreMessagesCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMMSData *data, int status)

Prototype for callback for store messages operation completion.

Parameters

session	[in] Pointer to address of session object
ophandle	[in] Data associated with operation
clientdata	[in] Data associated with session
data	[in] Internal SOM data handle
status	[in] Status for the operation

Returns

no return value

Definition at line 127 of file store.h.

SOMMSConnectionCallback

typedef void SOMMSConnectionCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMMSConnection *con, int status)

Prototype for callback for reporting connection object.

Parameters

session	[in] Pointer to address of session object
ophandle	[in] Data associated with operation
clientdata	[in] Data associated with session
con	[in] Pointer to opaque connection object
status	[in] Status for the operation

Returns

no return value

The connection object only exists for the duration of this callback.

Definition at line 145 of file store.h.

SOMMSMailboxCallback

typedef void SOMMSMailboxCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMMSMailbox *mbx, int status)

Prototype for callback for reporting mailbox object.

Parameters

session	[in] Pointer to address of session object
ophandle	[in] Data associated with operation
clientdata	[in] Data associated with session
mbx	[in] Pointer to opaque mailbox object
status	[in] Status for the operation

Returns

no return value

The mbx object only exists for the duration of this callback.

Definition at line 164 of file store.h.

SOMMSMessageCallback

typedef void SOMMSMessageCallback(struct SOMSession *session, void *ophandle, void *clientdata, struct SOMMSMessage *message, int status)

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
message	[in] Pointer to opaque message object
status	[in] Status for the operation

Returns

no return value

The message object only exists for the duration of this callback.

Recipients are accessed through this object.

Definition at line 185 of file store.h.