salsa 0.7.1
Loading...
Searching...
No Matches
Salsa::SocketZyre Class Reference

Salsa zyre socket class. More...

#include <SocketZyre.hh>

Inheritance diagram for Salsa::SocketZyre:
Salsa::Socket Salsa::Object

Public Member Functions

 SocketZyre (std::string name="no_name", std::map< std::string, std::string > headers={})
 
virtual ~SocketZyre ()
 
virtual int connect () final
 Connect function.
 
virtual int disconnect () final
 Disconnect function.
 
virtual Messagepull ()
 Pull message.
 
virtual int push (Message *)
 Push message.
 
int push (std::string, std::string)
 Push message to UUID.
 
void port (int newPort)
 Set zyre port.
 
int port () const
 Get zyre port.
 
virtual zyre_t * zyre () const
 Returns zyre pointer.
 
virtual zsock_t * socket () const
 Returns zyre socket pointer.
 
std::string header (const char *pKey) const
 Returns value for key from header.
 

Static Public Member Functions

static std::shared_ptr< spdlog::logger > getConsoleOutput ()
 Get console output.
 
static void setConsoleLevel (spdlog::level::level_enum level)
 Sets console log level.
 

Private Attributes

zyre_t * mpSocket = nullptr
 Zyre instance.
 
int mPort = 0
 Port for Zyre.
 
std::map< std::string, std::string > mHeaders = {}
 List of headers.
 

Static Private Attributes

static std::shared_ptr< spdlog::logger > mspConsoleLogger = spdlog::stdout_color_mt("salsa")
 Pointer to spd logger.
 

Detailed Description

Salsa zyre socket class.

Author
Matej Fedor matej.nosp@m..fed.nosp@m.or.mf.nosp@m.@gma.nosp@m.il.co.nosp@m.m
Martin Vala mvala.nosp@m.@cer.nosp@m.n.ch
Branislav Beke bbeke.nosp@m.@bad.nosp@m.haven.nosp@m..dev

Definition at line 18 of file SocketZyre.hh.

Constructor & Destructor Documentation

◆ SocketZyre()

Salsa::SocketZyre::SocketZyre ( std::string name = "no_name",
std::map< std::string, std::string > headers = {} )

Constructor with zyre name

Parameters
nameZyre name
headersList of headers

Definition at line 5 of file SocketZyre.cc.

References header(), mHeaders, and mpSocket.

◆ ~SocketZyre()

Salsa::SocketZyre::~SocketZyre ( )
virtual

Destructor

Definition at line 22 of file SocketZyre.cc.

References disconnect(), and mpSocket.

Member Function Documentation

◆ connect()

int Salsa::SocketZyre::connect ( )
finalvirtual

Connect function.

Connect zyre to the network

Implements Salsa::Socket.

Definition at line 33 of file SocketZyre.cc.

References mpSocket.

◆ disconnect()

int Salsa::SocketZyre::disconnect ( )
finalvirtual

Disconnect function.

Disconnect zyre from network

Implements Salsa::Socket.

Definition at line 43 of file SocketZyre.cc.

References mpSocket.

Referenced by ~SocketZyre().

◆ getConsoleOutput()

static std::shared_ptr< spdlog::logger > Salsa::Object::getConsoleOutput ( )
inlinestaticinherited

Get console output.

Definition at line 21 of file Object.hh.

References Salsa::Object::mspConsoleLogger.

Referenced by Salsa::ConfigZyre::apply().

◆ header()

std::string Salsa::SocketZyre::header ( const char * pKey) const
inline

Returns value for key from header.

Definition at line 47 of file SocketZyre.hh.

References mHeaders.

Referenced by SocketZyre().

◆ port() [1/2]

int Salsa::SocketZyre::port ( ) const
inline

Get zyre port.

Definition at line 39 of file SocketZyre.hh.

References mPort.

◆ port() [2/2]

void Salsa::SocketZyre::port ( int newPort)
inline

Set zyre port.

Definition at line 32 of file SocketZyre.hh.

References mPort, and mpSocket.

◆ pull()

Message * Salsa::SocketZyre::pull ( )
virtual

Pull message.

Pull message from the network

Implements Salsa::Socket.

Definition at line 56 of file SocketZyre.cc.

References mpSocket.

◆ push() [1/2]

int Salsa::SocketZyre::push ( Message * )
virtual

Push message.

Push message to the network

Implements Salsa::Socket.

Definition at line 66 of file SocketZyre.cc.

◆ push() [2/2]

int Salsa::SocketZyre::push ( std::string targetUUID,
std::string payload )

Push message to UUID.

Definition at line 79 of file SocketZyre.cc.

References mpSocket.

◆ setConsoleLevel()

static void Salsa::Object::setConsoleLevel ( spdlog::level::level_enum level)
inlinestaticinherited

Sets console log level.

Definition at line 29 of file Object.hh.

References Salsa::Object::mspConsoleLogger.

◆ socket()

virtual zsock_t * Salsa::SocketZyre::socket ( ) const
inlinevirtual

Returns zyre socket pointer.

Definition at line 45 of file SocketZyre.hh.

References mpSocket.

Referenced by Salsa::PollerZmq::add().

◆ zyre()

virtual zyre_t * Salsa::SocketZyre::zyre ( ) const
inlinevirtual

Returns zyre pointer.

Definition at line 42 of file SocketZyre.hh.

References mpSocket.

Referenced by Salsa::NodeManagerZyre::sendWhisper().

Member Data Documentation

◆ mHeaders

std::map<std::string, std::string> Salsa::SocketZyre::mHeaders = {}
private

List of headers.

Definition at line 52 of file SocketZyre.hh.

Referenced by header(), and SocketZyre().

◆ mPort

int Salsa::SocketZyre::mPort = 0
private

Port for Zyre.

Definition at line 51 of file SocketZyre.hh.

Referenced by port(), and port().

◆ mpSocket

zyre_t* Salsa::SocketZyre::mpSocket = nullptr
private

Zyre instance.

Definition at line 50 of file SocketZyre.hh.

Referenced by connect(), disconnect(), port(), pull(), push(), socket(), SocketZyre(), zyre(), and ~SocketZyre().

◆ mspConsoleLogger

std::shared_ptr< spdlog::logger > Salsa::Object::mspConsoleLogger = spdlog::stdout_color_mt("salsa")
staticprivateinherited

Pointer to spd logger.

Definition at line 32 of file Object.hh.

Referenced by Salsa::Object::getConsoleOutput(), and Salsa::Object::setConsoleLevel().


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