communication_line_interfaces.h

#ifndef SDK_COMMUNICATION_LINE_INTERFACES_H
#define SDK_COMMUNICATION_LINE_INTERFACES_H
 
#include <base/inc/platform.h>
#include <base/inc/base_types.h>
#include <base/inc/sdk_results.h>
#include <base/inc/sdk_string_handler.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/sdk_ref_ptr.h>
 
#include <base/inc/interfaces/parameters/parameters_interface.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <base/inc/interfaces/enum/enum_interface.h>
#include <base/inc/interfaces/connection_points/connection_points_interface.h>
 
#ifndef SDK_COMMUNICATIONLINE_NAMESPACE
#define SDK_COMMUNICATIONLINE_NAMESPACE SDK_NAMESPACE::communication_line
#endif // SDK_COMMUNICATIONLINE_NAMESPACE
 
#ifndef SDK_COMMUNICATIONLINE_BEGIN_NAMESPACE
#define SDK_COMMUNICATIONLINE_BEGIN_NAMESPACE SDK_BEGIN_NAMESPACE  \
                                    namespace communication_line {
#endif // SDK_COMMUNICATIONLINE_BEGIN_NAMESPACE
 
#ifndef SDK_COMMUNICATIONLINE_END_NAMESPACE
#define SDK_COMMUNICATIONLINE_END_NAMESPACE SDK_END_NAMESPACE }
#endif // SDK_COMMUNICATIONLINE_END_NAMESPACE
 
SDK_COMMUNICATIONLINE_BEGIN_NAMESPACE
 
FWD_DECL_INTERFACE(ICommunicationLine)
FWD_DECL_INTERFACE(ICommunicationLineEvent)
 
class ICommunicationLine : public ISDKProperties {
public:
  virtual SDKResult SDK_CALLTYPE Initialize(
    const ISDKParameters* params) throw() = 0;
  virtual SDKResult SDK_CALLTYPE Start() throw() = 0;
  virtual SDKResult SDK_CALLTYPE Stop() throw() = 0;
  virtual SDKResult SDK_CALLTYPE Send(
    const void* buffer, 
    SDKUInt32 size, 
    SDKUInt32** cookie) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetStatus(ISDKProperties* prop) throw() = 0;
 
  SDK_IMPLEMENT_IID(ICommunicationLine)
  SDK_END_INTERFACE(ICommunicationLine)
};
SDK_DECLARE_IID(ICommunicationLine)
 
class ICommunicationLineEvent : public sdk::ISDKComponent {
public:
  enum EventID
  {
    kNone = 0,           
    kStatusChanged,      
    kStarting,           
    kStarted,            
    kConnecting,         
    kConnected,          
    kAcceptConnection,   
    kConnectionAccepted, 
    kStopping,           
    kStopped,            
    kSending,            
    kSent,               
    kReceiving,          
    kReceived,           
    kTimer,              
  };
 
  virtual SDKResult SDK_CALLTYPE OnCommunicationEvent(
    EventID id,
    SDKUIntptr cookie,
    const SDKAny *data) throw() = 0;
 
  SDK_IMPLEMENT_IID(ICommunicationLineEvent)
  SDK_END_INTERFACE(ICommunicationLineEvent)
};
SDK_DECLARE_IID(ICommunicationLineEvent)
 
namespace utils {
  FWD_DECL_INTERFACE(ICommunicationLineUtils)
 
  enum InterfaceFlags {
    kInterfaceStatus_Up = 0x1,
    kInterfaceStatus_IPv4 = 0x2,
    kInterfaceStatus_IPv6 = 0x4,
    kInterfaceStatus_DHCP = 0x8,
    kInterfaceStatus_Multicast = 0x10,
  };
 
  enum InterfaceType {
    kInterfaceType_Ethernet = 1,
    kInterfaceType_Loopback = 2,
    kInterfaceType_Wlan = 3,
    kInterfaceType_Other = 4,
  };
 
  enum InterfaceProperties {
    kInterfaceProperties_Name,
    kInterfaceProperties_Friendlyname,
    kInterfaceProperties_Description,
    kInterfaceProperties_Type,
    kInterfaceProperties_UnicastIP,
    kInterfaceProperties_UnicastIPv6,
    kInterfaceProperties_MTU,
    kInterfaceProperties_MAC,
    kInterfaceProperties_Flags,
    kInterfaceProperties_TransmitLinkSpeed,
    kInterfaceProperties_ReceiveLinkSpeed,
  };
 
  class ICommunicationLineUtils : public SDK_NAMESPACE::ISDKComponent {
  public:
    virtual SDKResult SDK_CALLTYPE EnumNetworkInterfaces(
      SDK_NAMESPACE::IEnumSDKComponentSP& itfs) = 0;
    virtual SDKResult SDK_CALLTYPE IPv4ToString(const SDKUInt32 addr, 
      SDKString& s) const throw() = 0;
    virtual SDKResult SDK_CALLTYPE StringToIPv4(const SDKString& s, 
      SDKUInt32& addr) const throw() = 0;
 
    SDK_IMPLEMENT_IID(ICommunicationLineUtils)
    SDK_END_INTERFACE(ICommunicationLineUtils)
  };
  SDK_DECLARE_IID(ICommunicationLineUtils)
} // namespace utils
 
 
SDK_COMMUNICATIONLINE_END_NAMESPACE
 
#endif //SDK_COMMUNICATION_LINE_INTERFACES_H