//

// ESock messages and message signature definitions

//

ENUM ActivityId : UINT8

	ActivityNull						= 0

	ActivityNoBearer				    = 1

	ActivitySelect				    = 2

	BinderRequest			= 3

	ActivityBindTo       			= 4

	ClientJoin	    		= 5

	ClientLeave			    = 6

	ActivityStart				    = 7

	StartDataClient          = 8

	ActivityStop			            = 9

	StopDataClient			= 10

	ActivityGoneDown      			= 11

	ActivityDataClientGoneDown		= 12

	ActivityDestroy				    = 13

	ActivityAvailabilityNotification	= 14

	ActivityTierNotification			= 15

	MonitorProviderStatus	= 16

	ReportProviderStatus		= 17

	ActivityTierGetDataCollectors	= 18

	StoreProvision			= 19 

	ActivityDataClientActive      	= 20 

	ActivityDataClientIdle		    = 21 

	ForwardStateChange		= 22 

	ActivityError					= 23 	

	ErrorRecovery            = 24	

	GoneUp						= 25

	ActivityAny					= 26

	Notification				= 32

	ActivityRejoin				= 33

	ParamRequest             = 34

	ApplyChanges             = 35

	ConnectionStateChangeRequest = 36

	ActivityStateChange					= 37	

	ConnectionStartRecovery   	= 38

	ConnectionGoneDownRecovery 	= 39

	AvailabilityStart		= 40

	AvailabilityStop			= 41

	PolicyCheckRequest			= 42

	ActivityBuildStack				= 96

	ActivityProviderStatusChange 	= 97

	ActivityDataClientStatusChange	= 98

	ConnectionAttach             = 99

	ConnectionWaitForIncoming    = 100

	ConnSubConnEvents			= 101

	ConnectionAllInterfaceNotification 	= 102

	ActivityLegacyConnEnumResponse		= 103

	ConnectionEnumerateConnections		= 104

	ActivityStopSCPR 					= 105

	ActivityLegacyRMessage2Handler		= 106

	ConnectionLegacyRMessage2Handler		= 107

	SubConnectionLegacyRMessage2Handler		= 108

	ReportProviderStatusDeactivationWatcher = 109

	ImplicitFlow				= 112

	ConnectionFlow				= 113

	SubConnectionFlow			= 114

	GetParamLength				= 116

	GetParam					= 117

	ActivitySubConnectionCreate = 118

	DataClientJoin				= 122 

	ActivityBuildLowerLayer     = 123 

	ActivityReBindLayer         = 124 

	ActivityReConnect			= 125 

END ENUM

ENUM DECIMAL TStateChangeStage : UINT32

    KConnectionUninitialised  = 0

    KStartingSelection        = 1000

    KFinishedSelection        = 2000

    KConnectionFailure        = 2001

    KMinAgtProgress           = 2500

    KConnectionOpen           = 3500

    KConnectionClosed         = 4500

    KMaxAgtProgress           = 5500

    KMinNifProgress           = 6000

    KLinkLayerOpen            = 7000

    KLinkLayerClosed          = 8000

    KMaxNifProgress           = 9000

    // CSD Specific

    KCsdFinishedDialling = 2600

    KCsdScanningScript   = 2650

    KCsdScannedScript    = 2750

    KCsdGettingLoginInfo = 2800

    KCsdGotLoginInfo     = 2900

    KCsdFinishedConnect  = 3100

    KCsdStartingLogIn    = 3200

    KCsdFinishedLogIn    = 3250

END ENUM

INCLUDE "nodemessages.definition.txt"

CONST KESockInternalMessagesImplementationUid = 0x10285A57

ENUM ESock_SignatureId : UINT32

	ESignatureCommsBinder			=1

	ESignatureCommsBinderNumber		=2

	ESignatureSigAddrUpdate			=3

	ESignatureConnectionInfo		=4

	ESignatureProvisionConfig1		=5

	ESignatureSelectionPrefs		=6

	ESignatureSelectComplete		=7

	ESignaturePlaneNotification		=8

	ESignatureSubConnNotification	=9

	ESignatureSubConnOpenedEvent	=10

	ESignatureSubConnClosedEvent	=11

	ESignatureStateChange			=12

	ESignatureFactoryObjectParams   =13

	ESignatureBundleRMessage2		=14

	ESignatureBundle				=15

	ESignatureAvailabilitySubscriptionOptions = 16

	ESignatureAvailabilityStatus              = 17

	ESignatureNodeIdClientTypeNumber=18

	ESignatureFlowParams			=45

	ESignatureConnPrefList			=46

	ESignatureUpsParameters 		=47

	ESignatureFamilyBundle			=48

	ESignatureNumberFamilyBundle	=49

	ESignatureUpsStatusChange 		=50

	ESignatureMetaExtContainer      =51

	ESignatureConnectionInfoPtr     =52

	EFlowRequestBase				=1000

	EImplicitFlowRequest			=1001

	EConnFlowRequest				=1002

	ESubConnFlowRequest				=1003

	EReBindLayerRequest				=1004

	EDataClientJoiningRequest       =1005

	EGetOrSetParameters				=1006

END ENUM

ENUM TSubConnectionEventType : UINT32

	ESubConnectionOpened = 0

	ESubConnectionClosed = 1

	ESubConnectionQoSChanged = 1000

END ENUM

STRUCT TSubConnectionEvent

	UINT32 iSubConnectionUniqueId

	TSubConnectionEventType iEventType

	UINT32 iLength

END STRUCT

STRUCT TSubConnectionClosedEvent

	UINT32 iTotalUplinkDataVolume

	UINT32 iTotalDownlinkDataVolume

	UINT32 iTimeClosed_Low	 // low 32 bits universal time

	UINT32 iTimeClosed_High  // high 32 bits universal time

END STRUCT

STRUCT TCommsBinder

    Context_NodeId iCommsId

    INT32 iValue

END STRUCT

STRUCT TFactoryObjectParams

    UINT32 iUid

    Context_NodeId iControlProvider

    TMessageId iMessageId

    INT32 iDataClientType

END STRUCT

STRUCT TSockAddr

//    UINT8 iAddress[0x20] // TODO: Add support for arrays

	PAD 8			// descriptor length and maxlength

    PAD 0x20			// descriptor contents

END STRUCT

STRUCT TAddrUpdate

    TSockAddr iSrcSockAddr

    TSockAddr iDestSockAddr

    INT32 iProtocolId

    INT32 iIapId

END STRUCT

STRUCT TConnectionInfo

	UINT8 iVersion

	PAD 3

	UINT32 iIapId

	UINT32 iNetId

END STRUCT

STRUCT TConnPref	// TBuf<64>

//    UINT8 iAddress[0x40] // TODO: Add support for arrays

	PAD 8		// descriptor length and maxlength

	PAD 64		// descriptor contents

END STRUCT

STRUCT TSelectionPrefs

    PAD 12		// STypeId and length

    TConnPref iPrefs

    UINT32 iSelectionParams

    UINT32 iSubSessionUniqueId

END STRUCT

STRUCT TProviderInfo

    UINT32 iAPId

	UINT32 iTierId 

	UINT32 iInstance

END STRUCT

STRUCT TAvailabilityStatus

    INT32 iScore

END STRUCT

STRUCT TAvailabilitySubscriptionOptions

    UINT32 iAvailabilityFlags

END STRUCT

STRUCT RCFParameterFamilyBundle_const

	TCommsId iBundleId

END STRUCT

ENUM TFlowRequestType : UINT32

	EImplicit = 0

	EExplicitSubConnection = 1

	EExplicitConnection = 2

END ENUM

STRUCT TFlowParams

	UINT32 iAddrFamily

	UINT32 iProtocol

	UINT32 iSocketType

	TFlowRequestType iFlowRequestType

	UINT32 iSessionProxy

	UINT32 iFlowLoadsProtocol

END STRUCT

STRUCT TConnArgBase			// es_enum.h

	PAD 4

END STRUCT

STRUCT TTime

	UINT32 iTime_Lo			// TInt64 iTime

	UINT32 iTime_Hi

END STRUCT

STRUCT TSubConnectionInfo	// es_enum.h

	TConnArgBase iBase		// (base class)

	UINT32 iSubConnectionUniqueId

	UINT32 iConnectionType

	TTime iTimeStarted

END STRUCT

SIGNATURE TCFSigRMessage2Ext : TSignalBase

    TYPEID = 0:0 //has no id because it MUST to be derived from

	RMessage2 iMessage

END SIGNATURE

SIGNATURE TSigSubConNotification : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureSubConnNotification

	UINT32 iRefCountOwnedSubConNotification

END SIGNATURE

SIGNATURE TSigPlaneNotification : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignaturePlaneNotification

	UINT32 iRefCountOwnedNotification

END SIGNATURE

SIGNATURE TSigSubConnOpenedEvent : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureSubConnOpenedEvent

	TSubConnectionEvent iSubConnectionOpenedEvent

END SIGNATURE

SIGNATURE TSigSubConnClosedEvent : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureSubConnClosedEvent

    TSubConnectionClosedEvent iSubConnectionClosedEvent

END SIGNATURE

SIGNATURE TSigCommsBinder : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureCommsBinder

    TCommsBinder iCommsBinder

END SIGNATURE

SIGNATURE TSigFactoryObjectParams : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureFactoryObjectParams

	TFactoryObjectParams iFactoryObjectParams

END SIGNATURE

SIGNATURE TSigCommsBinderNumber : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureCommsBinderNumber

    TCommsBinder iCommsBinder

	UINT32 iValue

END SIGNATURE

SIGNATURE TSigAddrUpdate : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureSigAddrUpdate

	TAddrUpdate iAddrUpdate

END SIGNATURE

SIGNATURE TSigConnectionInfo : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureConnectionInfo

    TConnectionInfo iConnectionInfo

END SIGNATURE

SIGNATURE TSigSelectionPrefs : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureSelectionPrefs

    TSelectionPrefs iSelectionPrefs

END SIGNATURE

SIGNATURE TSigSelectComplete : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureSelectComplete

	Context_NodeId iNodeId

	TProviderInfo iProviderInfo

END SIGNATURE

SIGNATURE TSigBundle : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureBundle

	UINT32 iBundle

END SIGNATURE

SIGNATURE TSigFlowParams : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureFlowParams

	TFlowParams iFlowParams

END SIGNATURE

SIGNATURE TSigStateChange : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureStateChange

	TStateChange iStateChange

END SIGNATURE

SIGNATURE TSigBundleRMessage2 : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureBundleRMessage2

	UINT32 iBundle

	UINT32 iMessage

END SIGNATURE

SIGNATURE TSigFamilyBundle : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureFamilyBundle

	RCFParameterFamilyBundle_const iFamilyBundle

END SIGNATURE

SIGNATURE TSigNumberFamilyBundle : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureNumberFamilyBundle

	UINT32 iValue

	TCommsId iFamilyBundle

END SIGNATURE

SIGNATURE TSigMetaExtContainer : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureMetaExtContainer

	// RMetaExtensionContainerC iConfig

	UINT32 iConfig

END SIGNATURE

SIGNATURE TSigAvailabilitySubscriptionOptions : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureAvailabilitySubscriptionOptions

	TAvailabilitySubscriptionOptions iAvailabilitySubscriptionOptions

END SIGNATURE

SIGNATURE TSigAvailabilityStatus : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureAvailabilityStatus

	TAvailabilityStatus iAvailabilityStatus

END SIGNATURE

SIGNATURE TSigNodeIdClientTypeNumber : TSignatureBase

    TYPEID = KESockInternalMessagesImplementationUid:ESignatureNodeIdClientTypeNumber

	Context_NodeId iNodeId

	TClientType iClientType

	UINT32 iValue

END SIGNATURE

SIGNATURE TCFFlowRequestBase : TSignalBase

    TYPEID = KESockInternalMessagesImplementationUid:EFlowRequestBase

	UINT32 iSubSessionUniqueId

	TFlowParams iFlowParams

END SIGNATURE

SIGNATURE TImplicitFlowRequest : TCFFlowRequestBase

    TYPEID = KESockInternalMessagesImplementationUid:EImplicitFlowRequest

END SIGNATURE

SIGNATURE TConnFlowRequest : TCFFlowRequestBase

    TYPEID = KESockInternalMessagesImplementationUid:EConnFlowRequest

	UINT32 iSession

	UINT32 iHandle

END SIGNATURE

SIGNATURE TSubConnFlowRequest : TCFFlowRequestBase

    TYPEID = KESockInternalMessagesImplementationUid:ESubConnFlowRequest

	UINT32 iSession

	UINT32 iHandle

END SIGNATURE

SIGNATURE TDataClientJoiningRequest : TNodeSignal

    TYPEID = KESockInternalMessagesImplementationUid:EDataClientJoiningRequest

	Context_NodeId iDataClient

	TClientType iDataClientType

END SIGNATURE

SIGNATURE TGetOrSetParameters : TCFSigRMessage2Ext

    TYPEID = KESockInternalMessagesImplementationUid:EGetOrSetParameters

	UINT32 iDataObject

END SIGNATURE

// ss_nodemessages_legacy_internal.h

CONST KTCFLegacyMessageRealmId = 0x1028712F

ENUM EMessageTypeInternal : UINT32

//	EGetOrSetParameters				= 100

	EMCprGetConnectionSetting       = 101

END ENUM

ENUM TDataMonitoringDirection : UINT32

        EReceived = 0

        ESent = 1

END ENUM

SIGNATURE TCFSigLegacyRMessage2Ext : TSignatureBase

	TYPEID = 0:0			// derived from

	RMessage2 iMessage

END SIGNATURE

SIGNATURE TLegacyDataMonitoringNotificationRequest : TCFSigLegacyRMessage2Ext

	TYPEID = KTCFLegacyMessageRealmId:ELegacyDataMonitoringNotificationRequest

	TDataMonitoringDirection iDirection

	UINT32 iClientId

END SIGNATURE

ENUM TResponseType : UINT32

	ENormal = 0

	EPanic = 1

END ENUM

SIGNATURE TSigLegacyRMessage2Response : TSignatureBase

	TYPEID = KTCFLegacyMessageRealmId:ESignatureRMessage2Response

	TResponseType iType

	INT32 iCode

	PAD 48				// TBuf<20> iCatagory [sic] - 8 + 20 * 2

END SIGNATURE

SIGNATURE TLegacySubConnectionActiveRequest : TCFSigLegacyRMessage2Ext

	TYPEID = KTCFLegacyMessageRealmId:ELegacySubConnectionActiveRequest

	UINT32 iClientId					// TSubSessionUniqueId

END SIGNATURE

// ss_nodemessages_legacy.h

SIGNATURE TCprRetrieveProgress : TCFSigLegacyRMessage2Ext

	TYPEID = KTCFLegacyMessageRealmId:ECprRetrieveProgress

	TStateChange iLastProgress

END SIGNATURE

MESSAGE CprRetrieveProgress

    SIGNATURE = TCprRetrieveProgress

    MESSAGEID = KTCFLegacyMessageRealmId:ECprRetrieveProgress

END MESSAGE

SIGNATURE TCprRetrieveLastProgressError : TCFSigLegacyRMessage2Ext

	TYPEID = KTCFLegacyMessageRealmId:ECprRetrieveLastProgressError

	TStateChange iLastProgressError

END SIGNATURE

MESSAGE CprRetrieveLastProgressError

    SIGNATURE = TCprRetrieveLastProgressError

    MESSAGEID = KTCFLegacyMessageRealmId:ECprRetrieveLastProgressError

END MESSAGE

SIGNATURE TLegacyEnumerateSubConnections : TCFSigLegacyRMessage2Ext

    TYPEID = KTCFLegacyMessageRealmId:ELegacyEnumerateSubConnections

END SIGNATURE

MESSAGE LegacyEnumerateSubConnections

    SIGNATURE = TLegacyEnumerateSubConnections

    MESSAGEID = KTCFLegacyMessageRealmId:ELegacyEnumerateSubConnections

END MESSAGE

ENUM TCFLegacyMessageEnum : UINT32

	ECFLegacyRMessage2Processed     = 1

END ENUM

MESSAGE TLegacyRMessage2Processed

	SIGNATURE = TSigLegacyRMessage2Response

	MESSAGEID = KTCFLegacyMessageRealmId:ECFLegacyRMessage2Processed

END MESSAGE

ENUM TConnectionSettingType : UINT32		//  within TMCprGetConnectionSetting scope

	EIntSetting		= 0

	EBoolSetting	= 1

	EDes8Setting	= 2

	EDes16Setting	= 3

	ELongDesSetting	= 4

END ENUM

SIGNATURE TMCprGetConnectionSetting : TCFSigLegacyRMessage2Ext

	TYPEID = KTCFLegacyMessageRealmId:EMCprGetConnectionSetting