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

Describes events that may be fired by an endpoint. More...

#include <lwe_interface.h>

Inheritance diagram for ILWEEndpointEvent:
ISDKComponent

Public Member Functions

virtual SDKResult SDK_CALLTYPE OnMessageReceived (const ILWEMessageSP &message)=0 throw ()
 This event is fired when the endpoint received a new message. More...
 
virtual SDKResult SDK_CALLTYPE OnMessageSend (const LWEMsgID &id, const SDKUInt32 &status, const ILWESendMessageContextSP &context)=0 throw ()
 This event is fired when a message has been sent to the multicast group. More...
 
- Public Member Functions inherited from ISDKComponent
virtual SDKAtomicRefCount SDK_CALLTYPE AddRef () const =0 throw ()
 Increments the reference count for an interface on a component.

 
virtual SDKAtomicRefCount SDK_CALLTYPE Release () const =0 throw ()
 Decrements the reference count for an interface on a component.
 
virtual SDKResult SDK_CALLTYPE GetInterface (const InterfaceId &id, void **obj_ptr)=0 throw ()
 Returns pointers to the supported interfaces on a component.
 
template<typename _Itf >
SDKResult GetInterface (_Itf **obj_ptr) throw ()
 Returns pointers to the supported interfaces on a component.
 

Detailed Description

Describes events that may be fired by an endpoint.

Member Function Documentation

◆ OnMessageReceived()

virtual SDKResult SDK_CALLTYPE OnMessageReceived ( const ILWEMessageSP &  message)
throw (
)
pure virtual

This event is fired when the endpoint received a new message.

Parameters
[in]messageILWEMessage interface associated with the message
Returns
SDKResult_Succeeded or an error if fails

◆ OnMessageSend()

virtual SDKResult SDK_CALLTYPE OnMessageSend ( const LWEMsgID &  id,
const SDKUInt32 &  status,
const ILWESendMessageContextSP &  context 
)
throw (
)
pure virtual

This event is fired when a message has been sent to the multicast group.

Parameters
[in]idThe unique message id which has been assigned when the application started sending the message
Returns
SDKResult_Succeeded or an error if fails
The documentation for this class was generated from the following file: