#include <OTSocket.hpp>

Inheritance diagram for opentxs::OTSocket:

Collaboration diagram for opentxs::OTSocket:

Classes
class	Defaults

Public Member Functions
virtual	~OTSocket ()

EXPORT std::mutex *	GetMutex ()

EXPORT bool	Init (const Defaults &defaults)

EXPORT bool	Init (const Defaults &defaults, OTSettings *pSettings)

EXPORT bool	IsInitialized () const

EXPORT bool	HasContext () const

EXPORT bool	IsConnected () const

EXPORT bool	IsListening () const

EXPORT const OTString &	GetConnectPath () const

EXPORT const OTString &	GetBindingPath () const

virtual EXPORT bool	NewContext ()=0

virtual EXPORT bool	RemakeSocket (const bool bNewContext=false)=0

virtual EXPORT bool	Connect ()=0

virtual EXPORT bool	Listen ()=0

virtual EXPORT bool	Connect (const OTString &strConnectPath)=0

virtual EXPORT bool	Listen (const OTString &strBindingPath)=0

virtual EXPORT bool	Send (const OTASCIIArmor &ascEnvelope)=0

virtual EXPORT bool	Send (const OTASCIIArmor &ascEnvelope, const OTString &strConnectPath)=0

virtual EXPORT bool	Receive (OTString &strServerReply)=0

Protected Member Functions
	OTSocket ()

virtual bool	HandlePollingError ()=0

virtual bool	HandleSendingError ()=0

virtual bool	HandleReceivingError ()=0

Protected Attributes
int64_t	m_lLatencySendMs

int32_t	m_nLatencySendNoTries

int64_t	m_lLatencyReceiveMs

int32_t	m_nLatencyReceiveNoTries

int64_t	m_lLatencyDelayAfter

bool	m_bIsBlocking

bool	m_bInitialized

bool	m_HasContext

bool	m_bConnected

bool	m_bListening

OTString	m_strConnectPath

OTString	m_strBindingPath

OTASCIIArmor	m_ascLastMsgSent

Detailed Description

Definition at line 147 of file OTSocket.hpp.

Constructor & Destructor Documentation

opentxs::OTSocket::OTSocket ( )

protected

Definition at line 150 of file OTSocket.cpp.

     : m_Mutex()
     , m_lLatencySendMs(0)
     , m_nLatencySendNoTries(0)
     , m_lLatencyReceiveMs(0)
     , m_nLatencyReceiveNoTries(0)
     , m_lLatencyDelayAfter(0)
     , m_bIsBlocking(false)
     , m_bInitialized(false)
     , m_HasContext(false)
     , m_bConnected(false)
     , m_bListening(false)
     , m_strConnectPath("")
     , m_strBindingPath("")
 {
 }

virtual opentxs::OTSocket::~OTSocket ( )

inlinevirtual

Definition at line 208 of file OTSocket.hpp.

208 {};

Member Function Documentation

virtual EXPORT bool opentxs::OTSocket::Connect ( )

pure virtual

Implemented in opentxs::OTSocket_ZMQ_4.

virtual EXPORT bool opentxs::OTSocket::Connect ( const OTString & strConnectPath )

pure virtual

Implemented in opentxs::OTSocket_ZMQ_4.

const OTString & opentxs::OTSocket::GetBindingPath ( ) const

Definition at line 309 of file OTSocket.cpp.

 {
     return m_strBindingPath;
 }

const OTString & opentxs::OTSocket::GetConnectPath ( ) const

Definition at line 304 of file OTSocket.cpp.

 {
     return m_strConnectPath;
 }

std::mutex * opentxs::OTSocket::GetMutex ( )

Definition at line 197 of file OTSocket.cpp.

 {
     return m_Mutex.Get();
 }

virtual bool opentxs::OTSocket::HandlePollingError ( )

protectedpure virtual

virtual bool opentxs::OTSocket::HandleReceivingError ( )

protectedpure virtual

virtual bool opentxs::OTSocket::HandleSendingError ( )

protectedpure virtual

bool opentxs::OTSocket::HasContext ( ) const

Definition at line 289 of file OTSocket.cpp.

 {
     return m_HasContext;
 }

bool opentxs::OTSocket::Init ( const Defaults & defaults )

Definition at line 202 of file OTSocket.cpp.

 {
     if (m_bInitialized) return false;
     if (m_HasContext) return false;
     if (m_bConnected) return false;
     if (m_bListening) return false;
 
     m_lLatencySendMs = defaults.m_lLatencySendMs;
     m_nLatencySendNoTries = defaults.m_nLatencySendNoTries;
     m_lLatencyReceiveMs = defaults.m_lLatencyReceiveMs;
     m_nLatencyReceiveNoTries = defaults.m_nLatencyReceiveNoTries;
     m_lLatencyDelayAfter = defaults.m_lLatencyDelayAfter;
     m_bIsBlocking = defaults.m_bIsBlocking;
 
     m_bInitialized = true;
     return true;
 }

bool opentxs::OTSocket::Init	(	const Defaults &	defaults,
		OTSettings *	pSettings
	)

Definition at line 220 of file OTSocket.cpp.

 {
     if (m_bInitialized) return false;
     if (m_HasContext) return false;
     if (m_bConnected) return false;
     if (m_bListening) return false;
 
     if (nullptr == pSettings) {
         OT_FAIL;
     }
 
     bool bIsNew;
     {
         if (!pSettings->CheckSet_long("latency", KEY_LATENCY_SEND_MS,
                                       defaults.m_lLatencySendMs,
                                       m_lLatencySendMs, bIsNew)) {
             OT_FAIL;
         }
     }
     {
         int64_t lResult = 0;
         if (!pSettings->CheckSet_long("latency", KEY_LATENCY_SEND_NO_TRIES,
                                       defaults.m_nLatencySendNoTries, lResult,
                                       bIsNew)) {
             OT_FAIL;
         }
         m_nLatencySendNoTries = static_cast<int32_t>(lResult);
     }
     {
         if (!pSettings->CheckSet_long("latency", KEY_LATENCY_RECEIVE_MS,
                                       defaults.m_lLatencyReceiveMs,
                                       m_lLatencyReceiveMs, bIsNew)) {
             OT_FAIL;
         }
     }
     {
         int64_t lResult = 0;
         if (!pSettings->CheckSet_long("latency", KEY_LATENCY_RECEIVE_NO_TRIES,
                                       defaults.m_nLatencyReceiveNoTries,
                                       lResult, bIsNew)) {
             OT_FAIL;
         }
         m_nLatencyReceiveNoTries = static_cast<int32_t>(lResult);
     }
     {
         if (!pSettings->CheckSet_long("latency", KEY_LATENCY_DELAY_AFTER,
                                       defaults.m_lLatencyDelayAfter,
                                       m_lLatencyDelayAfter, bIsNew)) {
             OT_FAIL;
         }
     }
     {
         if (!pSettings->CheckSet_bool("latency", KEY_IS_BLOCKING,
                                       defaults.m_bIsBlocking, m_bIsBlocking,
                                       bIsNew)) {
             OT_FAIL;
         }
     }
 
     m_bInitialized = true;
 
     return true;
 }

bool opentxs::OTSocket::IsConnected ( ) const

Definition at line 294 of file OTSocket.cpp.

 {
     return m_bConnected;
 }

bool opentxs::OTSocket::IsInitialized ( ) const

Definition at line 284 of file OTSocket.cpp.

 {
     return m_bInitialized;
 }

bool opentxs::OTSocket::IsListening ( ) const

Definition at line 299 of file OTSocket.cpp.

 {
     return m_bListening;
 }

virtual EXPORT bool opentxs::OTSocket::Listen ( )

pure virtual

Implemented in opentxs::OTSocket_ZMQ_4.

virtual EXPORT bool opentxs::OTSocket::Listen ( const OTString & strBindingPath )

pure virtual

Implemented in opentxs::OTSocket_ZMQ_4.

virtual EXPORT bool opentxs::OTSocket::NewContext ( )

pure virtual

Implemented in opentxs::OTSocket_ZMQ_4.

virtual EXPORT bool opentxs::OTSocket::Receive ( OTString & strServerReply )

pure virtual

Implemented in opentxs::OTSocket_ZMQ_4.

virtual EXPORT bool opentxs::OTSocket::RemakeSocket ( const bool bNewContext = false )

pure virtual

Implemented in opentxs::OTSocket_ZMQ_4.

virtual EXPORT bool opentxs::OTSocket::Send ( const OTASCIIArmor & ascEnvelope )

pure virtual

Implemented in opentxs::OTSocket_ZMQ_4.

virtual EXPORT bool opentxs::OTSocket::Send	(	const OTASCIIArmor &	ascEnvelope,
		const OTString &	strConnectPath
	)

pure virtual

Implemented in opentxs::OTSocket_ZMQ_4.

Member Data Documentation

OTASCIIArmor opentxs::OTSocket::m_ascLastMsgSent

protected

Definition at line 201 of file OTSocket.hpp.

bool opentxs::OTSocket::m_bConnected

protected

Definition at line 195 of file OTSocket.hpp.

bool opentxs::OTSocket::m_bInitialized

protected

Definition at line 193 of file OTSocket.hpp.

bool opentxs::OTSocket::m_bIsBlocking

protected

Definition at line 191 of file OTSocket.hpp.

bool opentxs::OTSocket::m_bListening

protected

Definition at line 196 of file OTSocket.hpp.

bool opentxs::OTSocket::m_HasContext

protected

Definition at line 194 of file OTSocket.hpp.

int64_t opentxs::OTSocket::m_lLatencyDelayAfter

protected

Definition at line 190 of file OTSocket.hpp.

int64_t opentxs::OTSocket::m_lLatencyReceiveMs

protected

Definition at line 188 of file OTSocket.hpp.

int64_t opentxs::OTSocket::m_lLatencySendMs

protected

Definition at line 186 of file OTSocket.hpp.

int32_t opentxs::OTSocket::m_nLatencyReceiveNoTries

protected

Definition at line 189 of file OTSocket.hpp.

int32_t opentxs::OTSocket::m_nLatencySendNoTries

protected

Definition at line 187 of file OTSocket.hpp.

OTString opentxs::OTSocket::m_strBindingPath

protected

Definition at line 199 of file OTSocket.hpp.

OTString opentxs::OTSocket::m_strConnectPath

protected

Definition at line 198 of file OTSocket.hpp.

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

/usr/local/src/opentxs/include/opentxs/ext/OTSocket.hpp
/usr/local/src/opentxs/src/ext/OTSocket.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation