--- a/datacommsserver/esockserver/inc/ss_nodemessages_serviceprovider.h Fri Mar 12 15:49:41 2010 +0200
+++ b/datacommsserver/esockserver/inc/ss_nodemessages_serviceprovider.h Mon Mar 15 12:45:15 2010 +0200
@@ -40,67 +40,61 @@
ECFStopped = 4,
ECFCommsBinderRequest = 5,
ECFCommsBinderResponse = 6,
+ ECFCommsBindToComplete = 7,
};
protected:
public:
enum { ERealmId = 0x10285F4F }; //UID allocated on 4/6/08 from KUidNodeMessageRealms
- /*==========================================================================
- [Name]: TCommsBinderRequest
- [Semantics]: A request for a dataclient. Recipient has to respond with TCommsBinderResponse carrying
- one of its dataclients.
+ /**
+ A request for a dataclient. The recipient of TCommsBinderRequest has to respond with
+ TCommsBinderResponse carrying one of its data clients. Once the requestor (control client)
+ consumes the data client, the consumption is acknowledged back to the servicing node with
+ TCFServiceProvider::TBindToComplete.
+
+ @li Type: Request for TCommsBinderResponse
+ @li Fallible: Yes
- [Type]: Request for TCommsBinderResponse.
- [Fallible]: Yes.
-
- [Structure]:
- param: iValue - the semantics of this parameter depends on the recipient's plane:
+ @param iValue The semantics of this parameter depends on the recipient's plane:
CPR : - dataclient type, i.e.: EAttachToDefault/ECreateNew/EWaitForIncoming
SCPR: - protocol Id - could be left blank when not needed
MCPR: - attach flags (normal/monitor) 0 for start only
- iFamilyBundle - parameters to assist the finding/creation of dataclient
- ===========================================================================*/
+ @param iFamilyBundle parameters to assist the finding/creation of dataclient
+ */
typedef TMessageSigNumberDefaultFamilyBundleDefaultToNull<ECFCommsBinderRequest, TCFServiceProvider::ERealmId> TCommsBinderRequest;
-
- /*==========================================================================
- [Name]: TCommsBinderResponse
- [Semantics]: Sent to the control client as a response to TCommsBinderRequest and
- as a request for TBindToComplete
-
- [Type]: Request for TBindToComplete.
- Response to TCommsBinderRequest.
- [Fallible]: Yes.
+
+ /**
+ @li Type: Request for TCFServiceProvider::TBindToComplete
+ Response to TCFServiceProvider::TCommsBinderRequest
+ @li Fallible: Yes
+ @param iNodeId The requested binder
+
+ */
+ typedef Messages::TMessageSigNodeId<ECFCommsBinderResponse, TCFServiceProvider::ERealmId> TCommsBinderResponse;
+
+ /**
+ Response to TCommsBinderResponse.
+ @li Type: Response to TCommsBinderResponse
+ @param iValue Result of data client consumption
+ */
+ typedef Messages::TMessageSigNumberDefault<ECFCommsBindToComplete, TCFServiceProvider::ERealmId> TBindToComplete;
- [Structure]:
- param: iNodeId - the requested binder
- ===========================================================================*/
-
- typedef Messages::TMessageSigNodeId<ECFCommsBinderResponse, TCFServiceProvider::ERealmId> TCommsBinderResponse;
-
- /*==========================================================================
- [Name]: TStart
- [Semantics]: Request to start the stack. The recipient should start the stack below it
- and start its own layer.
-
- [Type]: Request for TStarted.
- [Fallible]: Yes.
-
- [Structure]:
- ===========================================================================*/
+ /**
+ Request to start the stack. The recipient should start the stack below it and start its own layer.
+ @li Type: Request for TStarted.
+ @li Fallible: Yes
+ */
typedef Messages::TMessageSigVoid<ECFStart, TCFServiceProvider::ERealmId> TStart;
typedef Messages::TMessageSigVoid<ECFStarted, TCFServiceProvider::ERealmId> TStarted;
- /*==========================================================================
- [Name]: TStop
- [Semantics]: Request to stop the stack. The recipient should stop its own layer
- and subsequently stop the stack below it.
+ /**
+ Request to stop the stack. The recipient should stop its own layer and subsequently stop the stack below it.
- [Type]: Request for TStopped.
- [Fallible]: No.
+ @li Type: Request for TStopped.
+ @li Fallible: No
- [Structure]:
- param: iValue - stop code (reason).
- ===========================================================================*/
+ @param: iValue - stop code (reason).
+ */
typedef Messages::TMessageSigNumber<ECFStop, TCFServiceProvider::ERealmId> TStop;
typedef Messages::TMessageSigNumber<ECFStopped, TCFServiceProvider::ERealmId> TStopped;
};
@@ -117,28 +111,24 @@
public:
enum { ERealmId = 0x10285F3F }; //UID allocated on 4/6/08 from KUidNodeMessageRealms
- /*==========================================================================
- [Name]: TGoneDown
- [Semantics]: Notification about the stack below gone down. This is an equivallent of
- of an unsolicited TStopped (i.e.: the stack below is notionally stopped).
+ /**
+ Notification about the stack below gone down. This is an equivallent of of an
+ unsolicited TStopped (i.e.: the stack below is notionally stopped).
- [Type]: Notification
+ @li Type: Notification
- [Structure]:
- param iValue1 - reason for going down.
+ @param iValue1 - reason for going down.
iValue2 - Access Point id as provisioned with CAccessPointConfig::ProviderInfo()::APId()
- ===========================================================================*/
+ */
typedef Messages::TMessageSigNumberDefaultNumberDefault<ECFGoneDown, TCFControlClient::ERealmId> TGoneDown;
- /*==========================================================================
- [Name]: TGoneUp
- [Semantics]: Notification about the stack below gone up. This is an equivallent of
- of an unsolicited TStarted (i.e.: the stack below is notionally started).
+
+ /**
+ Notification about the stack below gone up. This is an equivallent of of an unsolicited
+ TStarted (i.e.: the stack below is notionally started).
- [Type]: Notification
+ @li Type: Notification
- [Structure]:
- param None
- ===========================================================================*/
+ */
typedef Messages::TMessageSigVoid<ECFGoneUp, TCFControlClient::ERealmId> TGoneUp;
};