Object:Protocol_Protocol:Function:Receive_Message

Protocol_Protocol_Receive_Message

Header:

extern SFENCEAPI enum eSFENCE_Bool SFENCECALL Protocol_Protocol_Receive_Message(struct sProtocol_Protocol *ps_protocol, struct sEvent_Event **pps_event, struct sPack_Pack *ps_pack);

Parameters:

Parameter	Meaning
ps_protocol	pointer of Protocol_Protocol object
pps_event	pointer of Event_Event object. Can be pointer to NULL pointer. In that case Event_Event object will be create automatically.
ps_pack	pointer of Pack_Pack object which will be used for create Event_Event object if it isn't given to function.

Return value:

Value	Meaning
eSFENCE_Bool_True, eSFENCE_Bool_Success	message was received
eSFENCE_bool_False	no message received
eSFENCE_Bool_Fail	it means that there was happend some critical error in driver of Protocol_Protocol object.

Description:

Protocol_Protocol_Receive_Message function is used for receive message to protocol.
If Event_Event isn't given, create it with use Event_Event_Construct function.