m2etis  0.4
m2etis::net::NetworkInterface< NetworkType > Class Template Referenceabstract

NetworkInterface. More...

#include <NetworkInterface.h>

Inheritance diagram for m2etis::net::NetworkInterface< NetworkType >:
Inheritance graph

Public Member Functions

virtual ~NetworkInterface ()
 
void setCallback (NetworkCallbackInterface< NetworkType > *cb)
 Sets the callback-object on which the defined callbacks will be called. More...
 
virtual void send (const typename message::NetworkMessage< NetworkType >::Ptr msg, typename NodeHandle< NetworkType >::Ptr_const hint)=0
 Sends a message to the node which is responsible for the given key. Provide a hint for better routing. More...
 
virtual NodeHandle< NetworkType >::Ptr getSelfNodeHandle () const =0
 query your NodeHandle. You may query that for it's key. More...
 
virtual void registerMessageType (const typename NetworkType::MessageType type, const bool ack) const =0
 register a messagetype. Only registered types are sent. More...
 

Protected Attributes

net::NetworkCallbackInterface< NetworkType > * _callback
 returns an array of count neighbor nodes with priority to closer nodes. More...
 

Detailed Description

template<class NetworkType>
class m2etis::net::NetworkInterface< NetworkType >

NetworkInterface.

Long Desc

Definition at line 45 of file NetworkInterface.h.

Constructor & Destructor Documentation

template<class NetworkType>
virtual m2etis::net::NetworkInterface< NetworkType >::~NetworkInterface ( )
inlinevirtual

Definition at line 47 of file NetworkInterface.h.

Member Function Documentation

template<class NetworkType>
virtual NodeHandle<NetworkType>::Ptr m2etis::net::NetworkInterface< NetworkType >::getSelfNodeHandle ( ) const
pure virtual

query your NodeHandle. You may query that for it's key.

Returns
the NodeHandle to your underlying node.

Implemented in m2etis::sim::OmNetMediator, m2etis::wrapper::clocktcp::clockTcpWrapper, m2etis::wrapper::tcp::TcpWrapper, m2etis::wrapper::udp::UdpWrapper, and m2etis::wrapper::chimera::ChimeraWrapper.

Here is the caller graph for this function:

template<class NetworkType>
virtual void m2etis::net::NetworkInterface< NetworkType >::registerMessageType ( const typename NetworkType::MessageType  type,
const bool  ack 
) const
pure virtual

register a messagetype. Only registered types are sent.

Parameters
[in]typea number > 10
[in]acktrue if messages with this type should be acknowleged in network layer

Implemented in m2etis::sim::OmNetMediator.

Here is the caller graph for this function:

template<class NetworkType>
virtual void m2etis::net::NetworkInterface< NetworkType >::send ( const typename message::NetworkMessage< NetworkType >::Ptr  msg,
typename NodeHandle< NetworkType >::Ptr_const  hint 
)
pure virtual

Sends a message to the node which is responsible for the given key. Provide a hint for better routing.

Parameters
[in]msgThe Message to send
[in]hintThe additional hint for routing, may be null

Here is the caller graph for this function:

template<class NetworkType>
void m2etis::net::NetworkInterface< NetworkType >::setCallback ( NetworkCallbackInterface< NetworkType > *  cb)
inline

Sets the callback-object on which the defined callbacks will be called.

Parameters
[in]cbThe callback pointer

Definition at line 54 of file NetworkInterface.h.

Here is the caller graph for this function:

Member Data Documentation

template<class NetworkType>
net::NetworkCallbackInterface<NetworkType>* m2etis::net::NetworkInterface< NetworkType >::_callback
protected

returns an array of count neighbor nodes with priority to closer nodes.

Parameters
numthe count

Definition at line 93 of file NetworkInterface.h.


The documentation for this class was generated from the following file: