mfp_GetReply

Description

Gets the reply to a request to the Message Feed server.

The mfp_GetReply function is blocking. To avoid blocking the program while waiting for the reply, use the mfp_GetSocket function to obtain a socket that can be used in the C select function to wait for the socket to be ready for read or write access. To avoid memory leaks, use the mfp_FreeReply function to free the reply structure.

Syntax

t_mfpreply* mfp_GetReply(h_mfp hMFP, int Timeout);

Parameters

hMFP – Handle to the Message Feed connection.
Timeout – Timeout, in seconds, to wait for the reply. This timeout is not the same timeout as the socket access timeout which is defined in the mfp_Connect function.
The function returns a pointer to a structure of type t_mfpreply as defined below. This structure must be freed using the mfp_FreeReply function. A NULL value is returned in case of an error.
Use the mfp_GetLastError function to get a textual description of the error:

typedef struct {

int RequestType;

int RequestId;

int Status;

t_mfpreply_submitmsg SubmitMessage;

} t_mfpreply;

The RequestType field in the t_mfpreply structure is one of the following:
- MFP_REQUESTTYPE_AUTHENTICATE – if it is a reply to a mfp_Authenticate request
- MFP_REQUESTTYPE_SUBMITMESSAGE – if it is a reply to a mfp_SubmitMessage request.
The RequestId field in the t_mfpreply structure is the same request id as supplied in the mfp_Authenticate or mfp_SubmitMessage function.
The Status field in the t_mfpreply structure is the status of the request. You can use the mfp_StatusToString function to get a textual description of the status. The status can be any of the following:
- MFP_REPLYSTATUS_OK – The request was processed successfully.
- MFP_REPLYSTATUS_AUTHENTICATE_INVALIDDATA – A mfp_Authenticate request contained invalid data.
- MFP_REPLYSTATUS_AUTHENTICATE_AUTHENTICATIONFAIL – The user or password in an mfp_Authenticate function was invalid.
- MFP_REPLYSTATUS_SUBMITMESSAGE_INVALIDDATA – A mfp_SubmitMessage request contained invalid data.
- MFP_REPLYSTATUS_SUBMITMESSAGE_NOTAUTHENTICATED – Trying to submit a message without having authenticated to the Message Feed server.
- MFP_REPLYSTATUS_SUBMITMESSAGE_UNKNOWNACTIVITY – The Integration or Activity parameters in the mfp_SubmitMessage function refers an activity that is not known by the Message Feed server.
- MFP_REPLYSTATUS_SUBMITMESSAGE_INVALIDFILE – The FilePath parameter in the mfp_SubmitMessage function does not refer a valid file.
- MFP_REPLYSTATUS_SUBMITMESSAGE_UNKNOWNQUEUE – The Integration and Activity parameters in the mfp_SubmitMessage function refers an activity for which a queue does not exist. This error indicates an inconsistent run-time configuration in the system where the Message Feed server runs.
- MFP_REPLYSTATUS_SUBMITMESSAGE_SERVERERROR – An internal error occurred in the Message Feed server.
- MFP_REPLYSTATUS_SUBMITMESSAGE_TIMEOUT – No reply was received from the Message Feed server within the specified timeout.
The SubmitMessage field in the t_mfpreply structure is valid in case the reply is related to a mfp_SubmitMessage request. This field is a structure of type t_mfpreply_submitmsg as defined below.

typedef struct {

char* pFilePath;

char* pMessageId;

char* pLoggerId;

int Status;

} t_mfpreply_submitmsg;

The pFilePath parameter in the t_mfpreply_submitmsg structure is only set in case a reply message was requested in the mfp_SubmitMessage function. In this case, this field specifies the file path to the reply message.
The pMessageId parameter in the t_mfpreply_submitmsg structure specifies the user defined message ID of the message being submitted. This is the same as the MessageId parameter in the mfp_SubmitMsg function.
The pLoggerId parameter in the t_mfpreply_submitmsg structure specifies the logger ID assigned for the submitted message by the Message Feed server. The logger ID uniquely identifies a message in the integration engine.
The Status parameter in the t_mfpreply_submitmsg structure specifies the processing status of the submitted message. The status can be any of the following:
- MFP_SUBMITMESSAGE_STATUS_OK - The submitted message was processed OK.
- MFP_SUBMITMESSAGE_STATUS_PARTIALERROR - The submitted message was processed with some errors, i.e. one or several of the messages created from the submitted message was stopped.
- MFP_SUBMITMESSAGE_STATUS_ERROR - The submitted message was processed with error, i.e. all messages created from the submitted message was stopped.
- MFP_SUBMITMESSAGE_STATUS_TIMEOUT – The submitted message was not processed within the timeout specified in the mfp_SubmitMessage function.