Object:Protocol_Protocol:Function:Stop

Protocol_Protocol_Stop

Header:

extern SFENCEAPI enum eSFENCE_Bool SFENCECALL Protocol_Protocol_Stop(struct sProtocol_Protocol *ps_protocol);

Parameters:

Parameter	Meaning
ps_protocol	pointer of Protocol_Protocol

Return value:

Value	Meaning
eSFENCE_Bool_True, eSFENCE_Bool_Success	protocol work was stopped
eSFENCE_Bool_Fail	it means that there was happend some critical error in driver of Protocol_Protocol object.

Description:

Protocol_Protocol_Stop function is used for stop work with protocol. It can be called always. During work too. In that case it means that caller want protocol to finish work, usually, close connections and stop receiving and sending messages.