View on GitHub

Vistle

Distributed Data-parallel Scientific Visualization in VR

Public Member Functions | Public Attributes | List of all members
vistle::message::RequestTunnel Class Reference

request hub to listen on TCP port and forward incoming connections More...

#include <core/messages.h>

Inheritance diagram for vistle::message::RequestTunnel:
Inheritance graph
[legend]
Collaboration diagram for vistle::message::RequestTunnel:
Collaboration graph
[legend]

Public Member Functions

 DEFINE_ENUM_WITH_STRING_CONVERSIONS (AddressType,(Hostname)(IPv4)(IPv6)(Unspecified)) RequestTunnel(unsigned short srcPort
 establish tunnel - let hub forward incoming connections to srcPort to destHost::destPort More...
 
 RequestTunnel (unsigned short srcPort, const boost::asio::ip::address_v4 destHost, unsigned short destPort)
 establish tunnel - let hub forward incoming connections to srcPort to destHost::destPort More...
 
 RequestTunnel (unsigned short srcPort, const boost::asio::ip::address_v6 destHost, unsigned short destPort)
 establish tunnel - let hub forward incoming connections to srcPort to destHost::destPort More...
 
 RequestTunnel (unsigned short srcPort, unsigned short destPort)
 establish tunnel - let hub forward incoming connections to srcPort to destPort on local interface, address will be filled in by rank 0 of cluster manager More...
 
 RequestTunnel (unsigned short srcPort)
 remove tunnel More...
 
void setDestAddr (boost::asio::ip::address_v6 addr)
 
void setDestAddr (boost::asio::ip::address_v4 addr)
 
unsigned short srcPort () const
 
unsigned short destPort () const
 
AddressType destType () const
 
bool destIsAddress () const
 
std::string destHost () const
 
boost::asio::ip::address destAddr () const
 
boost::asio::ip::address_v6 destAddrV6 () const
 
boost::asio::ip::address_v4 destAddrV4 () const
 
bool remove () const
 
- Public Member Functions inherited from vistle::message::Message
 Message (const Type type, const unsigned int size)
 
unsigned long typeFlags () const
 processing flags for messages of a type, composed of RoutingFlags More...
 
void setUuid (const uuid_t &uuid)
 set message uuid More...
 
const uuid_tuuid () const
 message uuid More...
 
void setReferrer (const uuid_t &ref)
 set uuid of message which this message reacts to More...
 
const uuid_treferrer () const
 message this message refers to More...
 
Type type () const
 message type More...
 
int senderId () const
 sender ID More...
 
void setSenderId (int id)
 set sender ID More...
 
int rank () const
 sender rank More...
 
void setRank (int rank)
 set sender rank More...
 
int uiId () const
 UI id, if sent from a UI. More...
 
size_t size () const
 message size More...
 
bool isForBroadcast () const
 message has to be broadcast to all ranks? More...
 
void setForBroadcast (bool enable=true)
 mark message for broadcast to all ranks on destination More...
 
bool wasBroadcast () const
 was message broadcast to all ranks? More...
 
void setWasBroadcast (bool enable=true)
 mark message as broadcast to all ranks More...
 
bool isNotification () const
 message is not a request for action, just a notification that an action has been taken More...
 
void setNotify (bool enable)
 mark message as notification More...
 
int destId () const
 id of message destination More...
 
void setDestId (int id)
 set id of message destination More...
 
int destRank () const
 rank of message destination More...
 
void setDestRank (int r)
 set rank of destination More...
 
int destUiId () const
 id of destination UI More...
 
void setDestUiId (int id)
 set id of destination UI More...
 
size_t payloadSize () const
 number of additional data bytes following message More...
 
void setPayloadSize (size_t size)
 set payload size More...
 
std::string payloadName () const
 retrieve name of payload in shared memory More...
 
void setPayloadName (const shm_name_t &name)
 set name of payload in shared memory More...
 
CompressionMode payloadCompression () const
 compression method for payload More...
 
void setPayloadCompression (CompressionMode mode)
 set compression method for payload More...
 
size_t payloadRawSize () const
 number of uncompressed payload bytes More...
 
void setPayloadRawSize (size_t size)
 set number of uncompressed payload bytes More...
 
template<class SomeMessage >
SomeMessage & as ()
 
template<class SomeMessage >
SomeMessage const & as () const
 

Public Attributes

const std::string & destHost
 
const std::string unsigned short destPort
 

Additional Inherited Members

- Static Public Attributes inherited from vistle::message::MessageBase< RequestTunnel, REQUESTTUNNEL >
static const Type s_type
 
- Static Public Attributes inherited from vistle::message::Message
static const size_t MESSAGE_SIZE = 1024
 
- Protected Member Functions inherited from vistle::message::MessageBase< RequestTunnel, REQUESTTUNNEL >
 MessageBase ()
 
- Protected Attributes inherited from vistle::message::Message
uint64_t m_payloadSize
 payload size More...
 
uint64_t m_payloadRawSize
 raw (uncompressed) payload size More...
 
int m_payloadCompression
 payload compression method More...
 
shm_name_t m_payloadName
 name of payload in shared memory More...
 
bool m_forBroadcast
 broadcast to all ranks? More...
 
bool m_wasBroadcast
 
bool m_notification
 message is not a request for action More...
 
char m_pad [1] = {}
 pad message to multiple of 8 bytes More...
 

Detailed Description

request hub to listen on TCP port and forward incoming connections

Constructor & Destructor Documentation

◆ RequestTunnel() [1/4]

vistle::message::RequestTunnel::RequestTunnel ( unsigned short  srcPort,
const boost::asio::ip::address_v4  destHost,
unsigned short  destPort 
)

establish tunnel - let hub forward incoming connections to srcPort to destHost::destPort

◆ RequestTunnel() [2/4]

vistle::message::RequestTunnel::RequestTunnel ( unsigned short  srcPort,
const boost::asio::ip::address_v6  destHost,
unsigned short  destPort 
)

establish tunnel - let hub forward incoming connections to srcPort to destHost::destPort

◆ RequestTunnel() [3/4]

vistle::message::RequestTunnel::RequestTunnel ( unsigned short  srcPort,
unsigned short  destPort 
)

establish tunnel - let hub forward incoming connections to srcPort to destPort on local interface, address will be filled in by rank 0 of cluster manager

◆ RequestTunnel() [4/4]

vistle::message::RequestTunnel::RequestTunnel ( unsigned short  srcPort)

remove tunnel

Member Function Documentation

◆ DEFINE_ENUM_WITH_STRING_CONVERSIONS()

vistle::message::RequestTunnel::DEFINE_ENUM_WITH_STRING_CONVERSIONS ( AddressType  ,
(Hostname)(IPv4)(IPv6)(Unspecified)   
)

establish tunnel - let hub forward incoming connections to srcPort to destHost::destPort

◆ destAddr()

boost::asio::ip::address vistle::message::RequestTunnel::destAddr ( ) const

◆ destAddrV4()

boost::asio::ip::address_v4 vistle::message::RequestTunnel::destAddrV4 ( ) const

◆ destAddrV6()

boost::asio::ip::address_v6 vistle::message::RequestTunnel::destAddrV6 ( ) const

◆ destHost()

std::string vistle::message::RequestTunnel::destHost ( ) const

◆ destIsAddress()

bool vistle::message::RequestTunnel::destIsAddress ( ) const

◆ destPort()

unsigned short vistle::message::RequestTunnel::destPort ( ) const

◆ destType()

RequestTunnel::AddressType vistle::message::RequestTunnel::destType ( ) const

◆ remove()

bool vistle::message::RequestTunnel::remove ( ) const

◆ setDestAddr() [1/2]

void vistle::message::RequestTunnel::setDestAddr ( boost::asio::ip::address_v4  addr)

◆ setDestAddr() [2/2]

void vistle::message::RequestTunnel::setDestAddr ( boost::asio::ip::address_v6  addr)

◆ srcPort()

unsigned short vistle::message::RequestTunnel::srcPort ( ) const

Member Data Documentation

◆ destHost

std::string vistle::message::RequestTunnel::destHost

◆ destPort

unsigned short vistle::message::RequestTunnel::destPort

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