Object:Protocol_Protocol:DriverFunction:Check

fProtocol_Protocol_Check

Type:

typedef enum eSFENCE_Bool SFENCECALL (*fProtocol_Protocol_Check)(struct sProtocol_Protocol_Intern *ps_protocol);

Parameters:

Parameter	Meaning
ps_protocol	pointer of struct sProtocol_Protocol_Intern.

Return value:

Value	Meaning
eSFENCE_Bool_True, eSFENCE_Bool_Success	any message can be sent or received
eSFENCE_Bool_False	no message can be sent or received
eSFENCE_Bool_Fail	it means that there was happend some critical error durring checking protocol

Description:

fProtocol_Protocol_Check function is used for check protocol state.

Development:

It is good idea to use this driver function like core protocol function. You can receiving and sending data durring calling of this function.
Return eSFENCE_Bool_Fail when connection failed, nonsense data was received, internal driver error happen or something similar.

Callers API functions:

Caller	condition	meaning
Protocol_Protocol_Check	always	protocol check