Object:Protocol_Protocol:DriverFunction:Start

fProtocol_Protocol_Start

Type:

typedef enum eSFENCE_Bool SFENCECALL (*fProtocol_Protocol_Start)(struct sProtocol_Protocol_Intern *ps_protocol, struct sContainer_Container *ps_param);

Parameters:

Parameter	Meaning
ps_protocol	pointer of struct sProtocol_Protocol_Intern.
ps_param	pointer of Container_Container object. Can be NULL.

Return value:

Value	Meaning
eSFENCE_Bool_True, eSFENCE_Bool_Success	start protocol success.
eSFENCE_Bool_False	there something what do correct start of protocol unreachable
eSFENCE_Bool_Fail	it means that there was happend some critical error durring starting protocol

Description:

fProtocol_Protocol_Start function is used for protocol start.

Development:

Use default parameters if it is possible and ps_param is NULL. If it is impossible, return eSFENCE_Bool_Fail.
Returning of eSFENCE_Bool_False means something no failure. Etc. bad authorization, bad header, unsupported protocol version on second side and similar.

Callers API functions:

Caller	condition	meaning
Protocol_Protocol_Start	always	protocol start