Recent changes to Object:Protocol_Protocol:Function:Start

WikiPage Object:Protocol_Protocol:Function:Start modified by SFENCE

SFENCE — Sat, 16 Mar 2013 22:51:16 -0000

WikiPage Object:Protocol_Protocol:Function:Start modified by SFENCE

SFENCE — Sat, 16 Mar 2013 21:57:08 -0000

--- v1
+++ v2
@@ -4,13 +4,14 @@
 #####Header:#####

     :::C
-    extern SFENCEAPI enum eSFENCE_Bool SFENCECALL Protocol_Protocol_Start(struct sProtocol_Protocol *ps_protocol);
+    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%3AProtocol_Protocol)
+  ps_protocol | pointer of [Protocol_Protocol](Object%3AProtocol_Protocol) object
+  ps_param | pointer of [Container_Container](Object%3AContainer_Container) object, can be NULL

 #####Return value:#####

WikiPage Object:Protocol_Protocol:Function:Start modified by SFENCE

SFENCE — Sat, 16 Mar 2013 20:45:42 -0000

Protocol_Protocol_Start

extern SFENCEAPI enum eSFENCE_Bool SFENCECALL Protocol_Protocol_Start(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 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.