lwe_interface.h

Go to the documentation of this file.

#ifndef SDK_ECDIS_LWE_INTERFACE_H_
#define SDK_ECDIS_LWE_INTERFACE_H_
#pragma once
 
#include <base/inc/platform.h>
#include <base/inc/base_types.h>
#include <base/inc/forward_declarations.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <base/inc/interfaces/enum/enum_interface.h>
#include <base/inc/interfaces/parameters/parameters_interface.h>
#include <ecdislayer/inc/ecdislayer_const.h>
 
SDK_LWE_BEGIN_NAMESPACE
 
FWD_DECL_INTERFACE(ILWEMessage);
FWD_DECL_INTERFACE(ILWEMultiTextMessage);
FWD_DECL_INTERFACE(ILWETextMessageEdit);
FWD_DECL_INTERFACE(ILWEMultiTextMessageEdit);
FWD_DECL_INTERFACE(ILWEBinaryMessageEdit);
 
FWD_DECL_INTERFACE(ILWEFactory);
FWD_DECL_INTERFACE(ILWEFactoryUtils);
 
FWD_DECL_INTERFACE(ILWEEndpoint);
FWD_DECL_INTERFACE(ILWEEndpointEvent);
FWD_DECL_INTERFACE(ILWESendMessageContext);
 
FWD_DECL_INTERFACE(ILWEComposer);
 
FWD_DECL_INTERFACE(ILWEStatistics);
FWD_DECL_INTERFACE(ILWEStatisticsEvent);
 
FWD_DECL_INTERFACE(ILWEParserWrapper);
 
typedef enum TransmisionGroup {
  kTransmisionGroup_MISC = 0, 
  kTransmisionGroup_TGTD,     
  kTransmisionGroup_SATD,     
  kTransmisionGroup_NAVD,     
  kTransmisionGroup_VDRD,     
  kTransmisionGroup_RCOM,     
  kTransmisionGroup_TIME,     
  kTransmisionGroup_PROP,     
  kTransmisionGroup_USR1,     
  kTransmisionGroup_USR2,     
  kTransmisionGroup_USR3,     
  kTransmisionGroup_USR4,     
  kTransmisionGroup_USR5,     
  kTransmisionGroup_USR6,     
  kTransmisionGroup_USR7,     
  kTransmisionGroup_USR8,     
  kTransmisionGroup_BAM1,     
  kTransmisionGroup_BAM2,     
  kTransmisionGroup_CAM1,     
  kTransmisionGroup_CAM2,     
  kTransmisionGroup_BIN1,     
  kTransmisionGroup_BIN2,     
  kTransmisionGroup_BIN3,     
  kTransmisionGroup_BIN4,     
  kTransmisionGroup_BIN5,     
  kTransmisionGroup_BINRET1,  
  kTransmisionGroup_BINRET2,  
  kTransmisionGroup_BINRET3,  
  kTransmisionGroup_BINRET4,  
  kTransmisionGroup_BINRET5,  
  kTransmisionGroup_NETA,     
  kTransmisionGroup_PGP1,     
  kTransmisionGroup_PGP2,     
  kTransmisionGroup_PGP3,     
  kTransmisionGroup_PGP4,     
  kTransmisionGroup_PGB1,     
  kTransmisionGroup_PGB2,     
  kTransmisionGroup_PGB3,     
  kTransmisionGroup_PGB4,     
  kTransmisionGroup_SYSLOG,   
} TransmisionGroup;
 
typedef enum LWEMessageType {
  kLWEMessageType_Text,                 
  kLWEMessageType_MultiText,            
  kLWEMessageType_Binary,               
  kLWEMessageType_BinaryRetransmitted,  
} LWEMessageType;
 
typedef enum LWEMessageProperties {
  kLWEMessageProperties_SourceID,
  kLWEMessageProperties_DestinationID,
  kLWEMessageProperties_Data,
  kLWEMessageProperties_Host,
  kLWEMessageProperties_Port,
  kLWEMessageProperties_Time,
} LWEMessageProperties;
 
typedef enum LWETextMessageProperties {
  kLWETextMessageProperties_SourceID = kLWEMessageProperties_SourceID,
  kLWETextMessageProperties_DestinationID = kLWEMessageProperties_DestinationID,
  kLWETextMessageProperties_Data = kLWEMessageProperties_Data,
  kLWETextMessageProperties_Host = kLWEMessageProperties_Host,
  kLWETextMessageProperties_Port = kLWEMessageProperties_Port,
  kLWETextMessageProperties_PosixTime = kLWEMessageProperties_Time,
  kLWETextMessageProperties_GroupID = 0x100,
  kLWETextMessageProperties_LineNum,
  kLWETextMessageProperties_Text,
  kLWETextMessageProperties_RelativeTime,
  kLWETextMessageProperties_Authentication,
  kLWETextMessageProperties_UnknownTags,
} LWETextMessageProperties;
 
typedef enum LWEMultiTextMessageProperties {
  kLWEMultiTextMessageProperties_SourceID = kLWETextMessageProperties_SourceID,
  kLWEMultiTextMessageProperties_DestinationID = kLWETextMessageProperties_DestinationID,
  kLWEMultiTextMessageProperties_Data = kLWETextMessageProperties_Data,
  kLWEMultiTextMessageProperties_Host = kLWETextMessageProperties_Host,
  kLWEMultiTextMessageProperties_Port = kLWETextMessageProperties_Port,
  kLWEMultiTextMessageProperties_PosixTime = kLWEMessageProperties_Time,
  kLWEMultiTextMessageProperties_GroupID = kLWETextMessageProperties_GroupID,
  kLWEMultiTextMessageProperties_Text = kLWETextMessageProperties_Text,
  kLWEMultiTextMessageProperties_RelativeTime = kLWETextMessageProperties_RelativeTime,
  kLWEMultiTextMessageProperties_Authentication = kLWETextMessageProperties_Authentication,
  kLWEMultiTextMessageProperties_UnknownTags = kLWETextMessageProperties_UnknownTags,
  kLWEMultiTextMessageProperties_TotalNum = 0x200,
  kLWEMultiTextMessageProperties_GetDataAsEnum,
} LWEMultiTextMessageProperties;
 
 
typedef enum LWEBinaryMessageProperties {
  kLWEBinaryMessageProperties_SourceID = kLWEMessageProperties_SourceID,
  kLWEBinaryMessageProperties_DestinationID = kLWEMessageProperties_DestinationID,
  kLWEBinaryMessageProperties_Data = kLWEMessageProperties_Data,
  kLWEBinaryMessageProperties_Host = kLWEMessageProperties_Host,
  kLWEBinaryMessageProperties_Port = kLWEMessageProperties_Port,
  kLWEBinaryMessageProperties_Time = kLWEMessageProperties_Time,
  kLWEBinaryMessageProperties_Version = 0x300,
  kLWEBinaryMessageProperties_Status,
  kLWEBinaryMessageProperties_Device,
  kLWEBinaryMessageProperties_Channel,
  kLWEBinaryMessageProperties_Info,
  kLWEBinaryMessageProperties_Type,
  kLWEBinaryMessageProperties_Length,
  kLWEBinaryMessageProperties_ID,
  kLWEBinaryMessageProperties_AckPort,
  kLWEBinaryMessageProperties_TimeDiff,
} LWEBinaryMessageProperties;
 
typedef enum LWEBinaryMessageVersion {
  kLWEBinaryMessageVersion_Unknown = 0,  
  kLWEBinaryMessageVersion_1 = 1,        
  kLWEBinaryMessageVersion_2 = 2,        
} LWEBinaryMessageVersion;
 
typedef enum LWESocketType {
  kLWESocketType_Shared,    
  kLWESocketType_Exclusive, 
} LWESocketType;
 
typedef enum LWEEndpointType {
  kLWEEndpointType_UDP,         
  kLWEEndpointType_TCP_Client,  
  kLWEEndpointType_TCP_Server,  
} LWEEndpointType;
 
 
typedef enum LWEEndpointParameters {
  kLWEEndpointParameters_Host,
  kLWEEndpointParameters_Port,
  kLWEEndpointParameters_Group,
  kLWEEndpointParameters_Interface,
  kLWEEndpointParameters_SocketType,
  kLWEEndpointParameters_FilterMessagesBySourceID,
  kLWEEndpointParameters_AllowReceiveOwnMessages,
  kLWEEndpointParameters_IncomingBufferSize,
  kLWEEndpointParameters_OutgoingBufferSize,
  kLWEEndpointParameters_Bandwidth,
  kLWEEndpointParameters_MTU,
  kLWEEndpointParameters_BinaryMessageVersion,
  kLWEEndpointParameters_SuppressOwnPackets,
  kLWEEndpointParameters_LoopbackMode,
  kLWEEndpointParameters_Type,
  kLWEEndpointParameters_AuthenticationPresharedKey,
  kLWEEndpointParameters_TransmitterInstance,
  kLWEEndpointParameters_AllowBinaryMessageTypes,
} LWEEndpointParameters;
 
 
typedef enum LWEEndpointProperties {
  kLWEEndpointProperties_GetLineStatistics,
  kLWEEndpointProperties_ParserProperties,
  kLWEEndpointProperties_AddParser,
  kLWEEndpointProperties_RemoveParser,
  kLWEEndpointProperties_ResetLineStatistics,
  kLWEEndpointProperties_IsConnected,
} LWEEndpointProperties;
 
typedef enum LWEMessageComposerProperties {
  kLWEMessageComposerProperties_AuthenticationPresharedKey,
} LWEMessageComposerProperties;
 
typedef enum LWEStatistics {
  kLWEStatistics_Error_Common_InvalidHeader = 0,
  kLWEStatistics_Error_Text_TagFormating,
  kLWEStatistics_Error_Text_TagChecksum,
  kLWEStatistics_Error_Text_TagSyntax,
  kLWEStatistics_Error_Text_TagFraming,
  kLWEStatistics_Error_Text_TagLength,
  kLWEStatistics_Error_Text_SentenceSyntax,
  kLWEStatistics_Error_Text_SentenceLength,
  kLWEStatistics_Error_Text_SentenceChecksum,
  kLWEStatistics_Error_Text_SkipByAutehtication,
  kLWEStatistics_Error_Text_InvalidAutehtication,
  kLWEStatistics_Error_Text_SkipByTimeout,
 
  kLWEStatistics_Error_Binary_DatagramMissing,
  kLWEStatistics_Error_Binary_BlockNumber,
  kLWEStatistics_Error_Binary_InvalidHeader,
  kLWEStatistics_Error_Binary_SkipByTimeout,
 
  kLWEStatistics_Warning_Binary_Sent_NotAcknowledged,
  kLWEStatistics_Warning_Text_SkipByFilter = 0x80,
  kLWEStatistics_Warning_Binary_SkipByFilter,
} LWEStatistics;
 
typedef enum LWEMessageParserProperties {
  kLWEMessageParserProperties_Timeout,
  kLWEMessageParserProperties_Text_CheckLineCountTag,
  kLWEMessageParserProperties_Text_CheckTagCRC,
} LWEMessageParserProperties;
 
typedef enum LWEParsersPriority {
  kLWEParsersPriority_Highest = 1,  
  kLWEParsersPriority_High,         
  kLWEParsersPriority_Mid,          
  kLWEParsersPriority_Low,          
  kLWEParsersPriority_Lowest,       
} LWEParsersPriority;
 
typedef enum LWEParserResult {
  kLWEParserResult_Processed = 1, 
  kLWEParserResult_Skiped,        
  kLWEParserResult_Error,         
  kLWEParserResult_NotSupported,  
  kLWEParserResult_NotEnougthData,
} LWEParserResult;
 
 
typedef SDKUInt32 TransmisionGroupId;
typedef SDKString EndpointId;
typedef SDKUInt32 LWEMsgID;
static const LWEMsgID kInvalidLWEMsgID = static_cast<LWEMsgID>(-1);
typedef SDKUInt8 ParserPriority;
typedef SDKUInt32 ParserResult;
 
class ILWEFactory : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE CreateEndpointParameters(
    ISDKParametersSP& params) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE CreateEndpoint(const EndpointId& id,
    const ISDKParametersSP& parameters, ILWEEndpointSP& endpoint) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE CreateComposer(const EndpointId& id,
    ILWEComposerSP& composer) const throw() = 0;
 
  SDK_IMPLEMENT_IID(ILWEFactory)
  SDK_END_INTERFACE(ILWEFactory)
};
SDK_DECLARE_IID(ILWEFactory)
 
class ILWEFactoryUtils : public ISDKComponent {
public:
  virtual ILWEParserWrapperSP SDK_CALLTYPE CreateParserPropertiesWrapper(
    const SDKUInt8 priority, const ISDKComponentSP& component) const throw() = 0;
  virtual ILWEParserWrapperSP SDK_CALLTYPE CreateTextParserPropertiesWrapper(
    const ISDKComponentSP& component) const throw() = 0;
  virtual ILWEEndpointSP SDK_CALLTYPE GetSystemFunctionTransmitter() const throw() = 0;
  virtual ISDKPropertiesSP SDK_CALLTYPE GetErrorStats() const throw() = 0;
 
  SDK_IMPLEMENT_IID(ILWEFactoryUtils)
  SDK_END_INTERFACE(ILWEFactoryUtils)
};
SDK_DECLARE_IID(ILWEFactoryUtils)
 
 
class ILWEMessage : public ISDKProperties {
public:
  virtual SDKUInt32 SDK_CALLTYPE GetType() const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetSourceID(SDKString& id) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetDestinationID(SDKAny& id) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetData(SDKAny& data) const throw() = 0;
 
  SDK_IMPLEMENT_IID(ILWEMessage)
  SDK_END_INTERFACE(ILWEMessage)
};
SDK_DECLARE_IID(ILWEMessage)
 
 
class ILWETextMessageEdit : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE SetDestinationID(const SDKAny& id) throw() = 0;
  virtual SDKResult SDK_CALLTYPE SetData(const SDKAny& data) throw() = 0;
 
  SDK_IMPLEMENT_IID(ILWETextMessageEdit)
  SDK_END_INTERFACE(ILWETextMessageEdit)
};
SDK_DECLARE_IID(ILWETextMessageEdit)
 
 
class ILWEMultiTextMessage : public ILWEMessage {
public:
  virtual SDKResult SDK_CALLTYPE Next(
    ILWEMessageSP& message) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
 
  SDK_IMPLEMENT_IID(ILWEMultiTextMessage)
  SDK_END_INTERFACE(ILWEMultiTextMessage)
};
SDK_DECLARE_IID(ILWEMultiTextMessage)
 
 
class ILWEMultiTextMessageEdit : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE Next(
    ILWEMessageSP& message) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
 
  SDK_IMPLEMENT_IID(ILWEMultiTextMessageEdit)
  SDK_END_INTERFACE(ILWEMultiTextMessageEdit)
};
SDK_DECLARE_IID(ILWEMultiTextMessageEdit)
 
 
class ILWEBinaryMessageEdit : public ISDKProperties {
public:
  virtual SDKResult SDK_CALLTYPE SetDestinationID(const SDKAny& id) throw() = 0;
  virtual SDKResult SDK_CALLTYPE SetData(const SDKAny& data) throw() = 0;
  virtual SDKResult SDK_CALLTYPE SetVersion(const SDKAny& version) throw() = 0;
  virtual SDKResult SDK_CALLTYPE SetAckPort(const SDKAny& version) throw() = 0;
 
  SDK_IMPLEMENT_IID(ILWEBinaryMessageEdit)
  SDK_END_INTERFACE(ILWEBinaryMessageEdit)
};
SDK_DECLARE_IID(ILWEBinaryMessageEdit)
 
class ILWEEndpoint : public ISDKProperties {
public:
  virtual SDKResult SDK_CALLTYPE Start() throw() = 0;
  virtual SDKResult SDK_CALLTYPE Stop() throw() = 0;
  virtual SDKResult SDK_CALLTYPE IsStarted() const throw() = 0;
  virtual SDKResult SDK_CALLTYPE Send(const ILWEMessageSP& message,
    LWEMsgID& cookie) throw() = 0;
  virtual SDKResult SDK_CALLTYPE CreateMessage(SDKUInt32 type, const SDKAny& data,
    ILWEMessageSP& message) const throw() = 0;
 
  SDK_IMPLEMENT_IID(ILWEEndpoint)
  SDK_END_INTERFACE(ILWEEndpoint)
};
SDK_DECLARE_IID(ILWEEndpoint)
 
class ILWEComposer : public ISDKProperties {
public:
 
  virtual SDKResult SDK_CALLTYPE Compose(const ILWEMessageSP& message,
    SDKAny& data) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE CreateMessage(SDKUInt32 type, const SDKAny& data,
    ILWEMessageSP& message) const throw() = 0;
 
  SDK_IMPLEMENT_IID(ILWEComposer)
  SDK_END_INTERFACE(ILWEComposer)
};
SDK_DECLARE_IID(ILWEComposer)
 
 
typedef enum ILWEEndpointSendEvent {
  kILWEEndpointSendEvent_Successfull,  
  kILWEEndpointSendEvent_Error,        
} ILWESendEventStatus;
 
typedef enum LWESendMessageContext {
  kLWESendMessageContext_MessageType,  
  kLWESendMessageContext_BinaryID,     
} LWESendMessageContext;
 
class ILWESendMessageContext : public ISDKParameters {
  SDK_IMPLEMENT_IID(ILWESendMessageContext)
  SDK_END_INTERFACE(ILWESendMessageContext)
};
SDK_DECLARE_IID(ILWESendMessageContext)
 
 
class ILWEEndpointEvent : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE OnMessageReceived(
    const ILWEMessageSP& message) throw() = 0;
  virtual SDKResult SDK_CALLTYPE OnMessageSend(
    const LWEMsgID& id, const SDKUInt32& status, 
    const ILWESendMessageContextSP& context) throw() = 0;
 
  SDK_IMPLEMENT_IID(ILWEEndpointEvent)
  SDK_END_INTERFACE(ILWEEndpointEvent)
};
SDK_DECLARE_IID(ILWEEndpointEvent)
 
class ILWEStatistics : public ISDKProperties
{
public:
  virtual SDKResult SDK_CALLTYPE OnError(const SDKUInt32 type, 
    const SDKAny& id) throw() = 0;
  virtual SDKResult SDK_CALLTYPE OnError(const SDKUInt32 type, 
    const SDKString* data, const SDKAny& id) throw() = 0;
  virtual SDKResult SDK_CALLTYPE OnError(const SDKUInt32 type, 
    const SDKInt8* data, const SDKUInt32 length, const SDKAny& id) throw() = 0;
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetInfo(
    SDKString& host, SDKString& port, SDKString& itf) throw() = 0;
 
  SDK_IMPLEMENT_IID(ILWEStatistics)
  SDK_END_INTERFACE(ILWEStatistics)
};
SDK_DECLARE_IID(ILWEStatistics)
 
class ILWEParser : public ISDKProperties
{
public:
  virtual bool SDK_CALLTYPE IsSupported(const SDKAny* data) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Process(const ISDKPropertiesSP& properties,
    const SDKAny* data, SDKUInt32& result,
    IEnumSDKComponentSP& messages) throw() = 0;
 
  SDK_IMPLEMENT_IID(ILWEParser)
  SDK_END_INTERFACE(ILWEParser)
};
SDK_DECLARE_IID(ILWEParser)
 
FWD_DECL_INTERFACE(ILWEParserWrapper);
class ILWEParserWrapper : public ISDKComponent {
public:
  virtual SDKUInt8 SDK_CALLTYPE GetPriority() const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetComponent(ISDKComponentSP& component) const throw() = 0;
 
  template< typename T >
  SDKResult SDK_CALLTYPE GetComponentT(T** component) const throw() {
    ISDKComponentSP c;
    SDKResult res = GetComponent(c);
    if (SDK_FAILED(res) || !c)
      return kSDKResult_Error;
    return c->GetInterface<T>(component);
  }
 
  SDK_IMPLEMENT_IID(ILWEParserWrapper)
  SDK_END_INTERFACE(ILWEParserWrapper)
};
SDK_DECLARE_IID(ILWEParserWrapper)
 
 
SDK_LWE_END_NAMESPACE
 
#endif // SDK_ECDIS_LWE_INTERFACE_H_