Description of the function calls for message resubmission. More...
Macros | |
#define | SOM_FACILITY_RESUBMIT 5 |
Typedefs | |
typedef void | SOMResubmitCallback(struct SOMSession *session, void *ophandle, void *clientdata, int status, const char *opdata, size_t opdatalen) |
Prototype for callback for resubmit operation completion. More... | |
Functions | |
int | SOMResubmitSetCallback (struct SOMSession *session, SOMResubmitCallback *callback, SOMResubmitCallback **oldvalue) |
Set the resubmit callback function for this session. More... | |
int | SOMResubmit (struct SOMSession *session, const char *filename, const char *neworig, const char *newrecip, void *ophandle, int async) |
Set Logfile monitoring. More... | |
Detailed Description
Description of the function calls for message resubmission.
Macro Definition Documentation
◆ SOM_FACILITY_RESUBMIT
#define SOM_FACILITY_RESUBMIT 5 |
Mask used to request resubmit facility
Definition at line 26 of file resubmit.h.
Typedef Documentation
◆ SOMResubmitCallback
typedef void SOMResubmitCallback(struct SOMSession *session, void *ophandle, void *clientdata, int status, const char *opdata, size_t opdatalen) |
Prototype for callback for resubmit 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 opdata [in] Data returned by operation opdatalen [in] Length of data returned by operation
- Returns
- no return value
Callback used to indicate completion of asynchronous resubmit operation.
Data is set in the case of an error.
Definition at line 43 of file resubmit.h.
Function Documentation
◆ SOMResubmitSetCallback()
int SOMResubmitSetCallback | ( | struct SOMSession * | session, |
SOMResubmitCallback * | callback, | ||
SOMResubmitCallback ** | oldvalue | ||
) |
Set the resubmit 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
◆ SOMResubmit()
int SOMResubmit | ( | struct SOMSession * | session, |
const char * | filename, | ||
const char * | neworig, | ||
const char * | newrecip, | ||
void * | ophandle, | ||
int | async | ||
) |
Set Logfile monitoring.
- Parameters
-
session [in] Pointer to address of session object filename [in] Name of archive file neworig [in] New originator newrecip [in] New recipient ophandle [in] Value passed to callback async [in] Operation is asynchronous if TRUE
- Returns
- zero on success; non-zero on error
Resubmit the message contained in the archive indicated by the filename.
If neworig is not NULL, the originator of the message is changed.
If newrecip is NULL, then the message is resubmitted to all the original recipients. If nrecip is not NULL, then the message is sent only to this recipient. The recipient may be one of the original recipients of the message.
If asynchronous, the result is returned via the callback.