ESock::TCFTierStatusProvider Class Reference

class ESock::TCFTierStatusProvider

Message interface for tier status providers Nodes wishing to implement this interface must implment all message protocols in the interface.

Private Member Enumerations
enumanonymous { ECFTierStatusQuery = 1, ECFTierStatus = 2, ECFTierNotificationRegistration = 3, ECFTierNotification = 4 }
Public Member Type Definitions
typedef TMessageSigBundle< ECFTierNotification, TCFTierStatusProvider::ERealmId > TTierNotification
typedef TMessageSigBundleRMessage2< ECFTierNotificationRegistration, TCFTierStatusProvider::ERealmId > TTierNotificationRegistration
typedef TMessageSigBundle< ECFTierStatus, TCFTierStatusProvider::ERealmId > TTierStatus
typedef TMessageSigBundleRMessage2< ECFTierStatusQuery, TCFTierStatusProvider::ERealmId > TTierStatusQuery

Member Enumerations Documentation

Enum anonymous

Enumerators

ECFTierStatusQuery = 1
ECFTierStatus = 2
ECFTierNotificationRegistration = 3
ECFTierNotification = 4

Member Type Definitions Documentation

Typedef TTierNotification

typedef TMessageSigBundle< ECFTierNotification, TCFTierStatusProvider::ERealmId >TTierNotification

Notification of changes from TierManager to a querying node.

Example (responses to above registration): (empty bundle) - signifies the monitoring is active and all events from now on will be caught .. some time passes, then .. "Access point 6 is now started" .. some time passes, then .. "Access point 6 is now stopped" .. some time passes, then .. "Access point 6 is now started" .. etc. etc. ..

  • Type: Response to TTierNotificationRegistration

  • Fallible: No

Typedef TTierNotificationRegistration

typedef TMessageSigBundleRMessage2< ECFTierNotificationRegistration, TCFTierStatusProvider::ERealmId >TTierNotificationRegistration

Sent to a TierManager of interest by anyone (e.g. CConnectionServer) who wants to register for notifications of changes in status of a tier.

Example (registration): "Tell me when access point 6 changes in started status"

  • Type: Request for 1 - n TTierNotification notifications.

  • Fallible: Yes - generally early on when setting up the change monitoring.

Typedef TTierStatus

typedef TMessageSigBundle< ECFTierStatus, TCFTierStatusProvider::ERealmId >TTierStatus

Response from TierManager to a querying node (one off).

Example (response to above query): "Access points 2, 3 and 6 are started"

  • Type: Response to TTierStatusQuery

  • Fallible: No

Typedef TTierStatusQuery

typedef TMessageSigBundleRMessage2< ECFTierStatusQuery, TCFTierStatusProvider::ERealmId >TTierStatusQuery

Sent to a TierManager of interest by anyone (e.g. CConnectionServer) who wants to enquire (one off) for the status of that tier.

Example (query): "tell me which connections are started w.r.t. this tier"

  • Type: Request for TTierStatus response.

  • Fallible: Yes