ESock::TCFDataClient Class Reference

class ESock::TCFDataClient : public Messages::TEChild

Message interface for data clients Nodes wishing to implement this interface must implment all message protocols in the interface.

Inherits from

Public Member Enumerations
enumanonymous { ERealmId = 0x10285F42 }
Private Member Enumerations
enumanonymous {
ECFStart = 1, ECFStarted = 2, ECFStop = 3, ECFStopped = 4, ECFBindTo = 5, ECFBindToComplete = 6, ECFProvisionConfig = 7, ECFCommitBindTo = 8
}
enumanonymous { }
Inherited Enumerations
Messages::TEBase:@71
Messages::TEChild:@107
Public Member Type Definitions
typedef Messages::TMessageSigNodeIdNumberDefault< ECFBindTo, TCFDataClient::ERealmId > TBindTo
typedef Messages::TMessageSigVoid< ECFBindToComplete, TCFDataClient::ERealmId > TBindToComplete
typedef Messages::TMessageSigVoid< ECFCommitBindTo, TCFDataClient::ERealmId > TCommitBindTo
typedef TMessageSigMetaExtContainer< ECFProvisionConfig, TCFDataClient::ERealmId > TProvisionConfig
typedef Messages::TMessageSigVoid< ECFStart, TCFDataClient::ERealmId > TStart
typedef Messages::TMessageSigVoid< ECFStarted, TCFDataClient::ERealmId > TStarted
typedef Messages::TMessageSigNumber< ECFStop, TCFDataClient::ERealmId > TStop
typedef Messages::TMessageSigNumber< ECFStopped, TCFDataClient::ERealmId > TStopped

Member Enumerations Documentation

Enum anonymous

Enumerators

ECFStart = 1
ECFStarted = 2
ECFStop = 3
ECFStopped = 4
ECFBindTo = 5
ECFBindToComplete = 6
ECFProvisionConfig = 7
ECFCommitBindTo = 8

Enum anonymous

Enumerators

Enum anonymous

Enumerators

ERealmId = 0x10285F42

Member Type Definitions Documentation

Typedef TBindTo

typedef Messages::TMessageSigNodeIdNumberDefault< ECFBindTo, TCFDataClient::ERealmId >TBindTo

Recipient should accept the node provided as the new service provider. More precisely; the recipient should bind itself and the remainder of the layer it represents (its dataclients) to the layer supplied by the sender of TBindTo. TBindTo may be sent when processing TControlClient::TNoBearer or for other reasons (e.g.: building the layer or rebinding the layer during mobility scenarios). The sender of TBindTo should supply a startable layer, i.e.: as far as the sender is concerned the layer has a chance to start. For instance; if an SCPR receives TBindTo, then the sender CPR has started the connection, which means the SCPR's attempt to start its new service provider has a chance of succeeding.

  • Type: Request for TBindToComplete

  • Fallible: Yes.

Typedef TBindToComplete

typedef Messages::TMessageSigVoid< ECFBindToComplete, TCFDataClient::ERealmId >TBindToComplete

Typedef TCommitBindTo

typedef Messages::TMessageSigVoid< ECFCommitBindTo, TCFDataClient::ERealmId >TCommitBindTo

Typedef TProvisionConfig

typedef TMessageSigMetaExtContainer< ECFProvisionConfig, TCFDataClient::ERealmId >TProvisionConfig

The message provisions all the necessary information to configure the recipient. This is typically sent by a control provider to its freshly created dataclient. The message should contain all the data structures required by the recipient to function. For instance, an Ethernet flow should be provision with the static IP address info (if applicable).

  • Type: Notification

IMPORTANT: There is no response to TProvisionConfig. If the recipient finds out that the configuration received is in any way inadequate, it cannot flag this fact until it is requested to do something (e.g.: TCFDataClient::Start) it can't (due to inadequate configuration).

Typedef TStart

typedef Messages::TMessageSigVoid< ECFStart, TCFDataClient::ERealmId >TStart

Request to start the layer. The recipient should perform the 'start' routine pertaining to the technology/abstraction it represents. The recipient would usually send TStart to its dataclients in the course of implementing this request.

  • Type: Request for TStarted.

  • Fallible: Yes.

Typedef TStarted

typedef Messages::TMessageSigVoid< ECFStarted, TCFDataClient::ERealmId >TStarted

Typedef TStop

typedef Messages::TMessageSigNumber< ECFStop, TCFDataClient::ERealmId >TStop

Sent to a dataclient to request permanent stop of the layer.

  • Type: Request for TStopped.

  • Fallible: No.

Typedef TStopped

typedef Messages::TMessageSigNumber< ECFStopped, TCFDataClient::ERealmId >TStopped