NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
Public Member Functions
ILWEEndpoint Class Referenceabstract
ECDIS Layer » Lightweight Ethernet » Endpoint

Main object to communicate with the LWE interface. More...

#include <lwe_interface.h>

Inherits ISDKProperties.

Public Member Functions

virtual SDKResult SDK_CALLTYPE Start ()=0 throw ()
 Connects the endpoint to the multicast group. More...
 
virtual SDKResult SDK_CALLTYPE Stop ()=0 throw ()
 Disconnects the endpoint from the multicast group. More...
 
virtual SDKResult SDK_CALLTYPE IsStarted () const =0 throw ()
 Indicates if the endpoint is being started. More...
 
virtual SDKResult SDK_CALLTYPE Send (const ILWEMessageSP &message, LWEMsgID &cookie)=0 throw ()
 Sends a message to the multicast group. More...
 
virtual SDKResult SDK_CALLTYPE CreateMessage (SDKUInt32 type, const SDKAny &data, ILWEMessageSP &message) const =0 throw ()
 Creates a message with a specified type. More...
 

Detailed Description

Main object to communicate with the LWE interface.

Member Function Documentation

◆ Start()

virtual SDKResult SDK_CALLTYPE Start ( )
throw (
)
pure virtual

Connects the endpoint to the multicast group.

Returns
SDKResult_Succeeded or an error if fails

◆ Stop()

virtual SDKResult SDK_CALLTYPE Stop ( )
throw (
)
pure virtual

Disconnects the endpoint from the multicast group.

Returns
SDKResult_Succeeded or an error if fails

◆ IsStarted()

virtual SDKResult SDK_CALLTYPE IsStarted ( ) const
throw (
)
pure virtual

Indicates if the endpoint is being started.

Returns
kSDKResult_True
kSDKResult_False

◆ Send()

virtual SDKResult SDK_CALLTYPE Send ( const ILWEMessageSP &  message,
LWEMsgID &  cookie 
)
throw (
)
pure virtual

Sends a message to the multicast group.

Parameters
[in]messageILWEMessage interface associated with the message
[out]cookieA unique ID of the sent message (see ILWEEndpointEvent interface)
Returns
SDKResult_Succeeded or an error if fails

◆ CreateMessage()

virtual SDKResult SDK_CALLTYPE CreateMessage ( SDKUInt32  type,
const SDKAny &  data,
ILWEMessageSP &  message 
) const
throw (
)
pure virtual

Creates a message with a specified type.

Parameters
[in]typeMessage type (see LWEMessageType enum)
[in]dataMessage content (string, string enum or raw binary data)
[out]messageILWEMessage interface associated with the message
Returns
SDKResult_Succeeded or an error if fails
The documentation for this class was generated from the following file: