Menu

Object:Protocol_Protocol:Function:Start

SFENCE

Protocol_Protocol_Start

Header:
extern SFENCEAPI enum eSFENCE_Bool SFENCECALL Protocol_Protocol_Start(struct sProtocol_Protocol *ps_protocol, struct sContainer_Container *ps_param);
Parameters:
Parameter Meaning
ps_protocol pointer of Protocol_Protocol object
ps_param pointer of Container_Container object, can be NULL
Return value:
Value Meaning
eSFENCE_Bool_True, eSFENCE_Bool_Success protocol was started
eSFENCE_bool_False protocol cannot be started
eSFENCE_Bool_Fail it means that there was happend some critical error in driver of Protocol_Protocol object.
Description:

Protocol_Protocol_Start function is used for initialize protocol work. It can do opening connections, send header data or something like it. Do nothing is possible too. It depends on protocol and extension type.
Function can return eSFENCE_bool_False value. For etc, if second side isn't supported required version of protocol. Or something like it.


Related

Wiki: Object:Protocol_Protocol:DriverFunction:Start
Wiki: Object:Protocol_Protocol