BusSession Class Reference

Public Member Functions
	BusSession (const SessionSettings &settings, SessionListener *listener, SessionStorageType::Enum storageType=SessionStorageType::FileBased, SessionStorage *storage=nullptr, const std::string &customKey={}, const Utils::BuildInfo &=Utils::consumerBuildInfo())
	BusSession (SessionReactor &stack, const SessionSettings &settings, SessionListener *listener, SessionStorageType::Enum storageType=SessionStorageType::FileBased, SessionStorage *storage=nullptr, const std::string &customKey={}, const Utils::BuildInfo &=Utils::consumerBuildInfo())
	BusSession (ServiceFactory &service, const SessionSettings &settings, SessionListener *listener, SessionStorageType::Enum storageType=SessionStorageType::FileBased, SessionStorage *storage=nullptr, const std::string &customKey={}, const Utils::BuildInfo &=Utils::consumerBuildInfo())
Session &	connect (const std::string &host, Port port)
Threading::SharedFuture< void >	connectAsync (const std::string &host, Port port)
Threading::SharedFuture< BgwCredentials >	getBgwCredentialsAsync (const std::string &userId, bool forceRequest=0) final
Public Member Functions inherited from Session
	Session (SessionType::Enum sessionType, const SessionSettings &settings, SessionListener *listener, SessionStorageType::Enum storageType=SessionStorageType::FileBased, SessionStorage *storage=nullptr, const std::string &customKey={}, const Utils::BuildInfo &=Utils::consumerBuildInfo())
	Session (SessionReactor &stack, SessionType::Enum sessionType, const SessionSettings &settings, SessionListener *listener, SessionStorageType::Enum storageType=SessionStorageType::FileBased, SessionStorage *storage=nullptr, const std::string &customKey={}, const Utils::BuildInfo &=Utils::consumerBuildInfo())
	Session (ServiceFactory &service, SessionType::Enum sessionType, const SessionSettings &settings, SessionListener *listener, SessionStorageType::Enum storageType=SessionStorageType::FileBased, SessionStorage *storage=nullptr, const std::string &customKey={}, const Utils::BuildInfo &=Utils::consumerBuildInfo())
	~Session ()
std::string	id () const
int	clientId () const noexcept
std::string	userId () const noexcept
std::string	customKey () const
Session &	connect (const std::string &host, Port port, const std::string &ipSessionToken={})
Threading::SharedFuture< void >	connectAsync (const std::string &host, Port port, const std::string &ipSessionToken={})
Session &	disconnect (const std::string &reason={})
Threading::SharedFuture< void >	disconnectAsync (const std::string &reason={})
Session &	breakConnection ()
Threading::SharedFuture< void >	breakConnectionAsync ()
template<typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
Session &	send (Messaging::MessageHolder< SbeMessageType, MaxMessageSize, MessageInitializer > &msg, Messaging::Timestamp sendingTime=UtcWatch::now())
template<typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
Session &	send (Messaging::MessageHolder< SbeMessageType, MaxMessageSize, MessageInitializer > &&msg, Messaging::Timestamp sendingTime=UtcWatch::now())
template<typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
Session &	send (MessageBatch< SbeMessageType, MaxMessageSize, MessageInitializer > &msgs, Messaging::Timestamp sendingTime=UtcWatch::now(), size_t maxPacketSize=MaxPacketSize)
Session &	send (MessageBatchCombiner &msgs, Messaging::Timestamp sendingTime=UtcWatch::now(), size_t maxPacketSize=MaxPacketSize)
Session &	send (NetworkMessage *begin, NetworkMessage *end, Messaging::Timestamp sendingTime=UtcWatch::now(), size_t maxPacketSize=MaxPacketSize) ONIXS_ICEBOE_NONULL
Session &	send (NetMessagesRange range, Messaging::Timestamp sendingTime=UtcWatch::now(), size_t maxPacketSize=MaxPacketSize)
Session &	sendSequenceMessage ()
template<typename SbeMessageType, size_t MaxMessageSize>
Session &	warmUp (Messaging::MessageHolder< SbeMessageType, MaxMessageSize > &msg, Messaging::Timestamp sendingTime=UtcWatch::now(), int warmupFlags=0)
template<typename SbeMessageType, size_t MaxMessageSize, typename MessageInitializer>
Session &	warmUp (MessageBatch< SbeMessageType, MaxMessageSize, MessageInitializer > &msgs, Messaging::Timestamp sendingTime=UtcWatch::now(), size_t maxPacketSize=MaxPacketSize, int warmupFlags=0)
Session &	warmUp (MessageBatchCombiner &msgs, Messaging::Timestamp sendingTime=UtcWatch::now(), size_t maxPacketSize=MaxPacketSize, int warmupFlags=0)
Session &	warmUp (NetworkMessage *begin, NetworkMessage *end, Messaging::Timestamp sendingTime=UtcWatch::now(), size_t maxPacketSize=MaxPacketSize, int warmupFlags=0) ONIXS_ICEBOE_NONULL
Session &	warmUp (NetMessagesRange range, Messaging::Timestamp sendingTime=UtcWatch::now(), size_t maxPacketSize=MaxPacketSize, int warmupFlags=0)
Session &	throttle ()
size_t	tryThrottle ()
Session &	throttlingLimit (size_t messagesCount, size_t intervalInMs=1000)
std::string	remoteHost () const
std::string	remoteIpAddress () const
Port	remotePort () const
std::pair< Port, Port >	localPortRange () const noexcept
Session &	localPortRange (std::pair< Port, Port > portRange)
std::string	localNetworkInterface () const
Session &	localNetworkInterface (const std::string &value)
Port	localPort () const
bool	tcpNoDelayOption () const
Session &	tcpNoDelayOption (bool value)
const SocketOptions &	socketOptions () const
Session &	socketOptions (const SocketOptions &options)
Session &	receivingThreadAffinity (CpuIndex cpuIndex)
Session &	receivingThreadAffinity (const CpuIndexes &cpuIndexes)
const CpuIndexes &	receivingThreadAffinity () const
Session &	sendingThreadAffinity (CpuIndex cpuIndex)
Session &	sendingThreadAffinity (const CpuIndexes &cpuIndexes)
const CpuIndexes &	sendingThreadAffinity () const
int	receivingThreadPriority () const
Session &	receivingThreadPriority (int priority)
int	sendingThreadPriority () const
Session &	sendingThreadPriority (int priority)
int	receivingThreadPolicy () const
Session &	receivingThreadPolicy (int policy)
int	sendingThreadPolicy () const
Session &	sendingThreadPolicy (int policy)
unsigned	receiveSpinningTimeout () const noexcept
Session &	receiveSpinningTimeout (unsigned timeoutInUs)
unsigned	sendSpinningTimeout () const noexcept
Session &	sendSpinningTimeout (unsigned timeoutInUs)
bool	reportNewMessagesWhileWaitingForMissedMessages () const
Session &	reportNewMessagesWhileWaitingForMissedMessages (bool value)
unsigned	messageGrouping () const noexcept
Session &	messageGrouping (unsigned numberOfMessagesToGroup)
SessionStorageType::Enum	storageType () const noexcept
const std::string &	storageId () const noexcept
SeqNumber	outSeqNum () const noexcept
Session &	outSeqNum (SeqNumber nextOutSeqNum)
SeqNumber	inSeqNum () const
Session &	inSeqNum (SeqNumber nextExpectedInSeqNum)
Session &	reset ()
SessionStateId::Enum	state () const
Messaging::Timestamp	creationTime () const noexcept
void	flushSessionStorage ()
unsigned	reconnectAttempts () const
Session &	reconnectAttempts (unsigned reconnectAttempts)
unsigned	reconnectInterval () const
Session &	reconnectInterval (unsigned seconds)
bool	localTimeUsage () const
Session &	localTimeUsage (bool useLocalTime)
const std::string &	storageDirectory () const
bool	logBeforeSending () const
Session &	logBeforeSending (bool value)
size_t	incomingMessageGapQueueMaximumSize () const
Session &	incomingMessageGapQueueMaximumSize (size_t value)
const Session &	log (const std::string &message) const
std::string	toString () const
Messaging::Timestamp	licenseExpirationDate () const
Messaging::SchemaVersion	messagingVersion () const noexcept
Handle	socketHandle ()
size_t	outboundQueueBytes ()
bool	getTcpInfo (TcpInfo &)
Public Member Functions inherited from IBgwCredentialsProvider
virtual	~IBgwCredentialsProvider ()=default

Additional Inherited Members
Static Public Member Functions inherited from Session
static const char *	version () noexcept
Static Public Attributes inherited from Session
static const size_t	MaxPacketSize = 1420
static const int	UndefinedAffinity = -1
static const Handle	InvalidSocketHandle
Protected Member Functions inherited from Session
Threading::SharedFuture< BgwCredentials >	getBgwCredentialsAsync (const std::string &userId, bool forceRequest)

Detailed Description

Definition at line 28 of file BusSession.h.

Constructor & Destructor Documentation

BusSession() [1/3]

BusSession ( const SessionSettings & settings, SessionListener * listener, SessionStorageType::Enum storageType = SessionStorageType::FileBased, SessionStorage * storage = nullptr, const std::string & customKey = {}, const Utils::BuildInfo & = Utils::consumerBuildInfo() )

inline

Constructor.

Parameters

settings	Session settings.
listener	Session listener.
storageType	Session storage type.
storage	Session storage.
customKey	Custom key that could be used to distinguish sessions with the same UserID and ClientId values.

Definition at line 40 of file BusSession.h.

                                                                        {}, const Utils::BuildInfo & = Utils::consumerBuildInfo())
        : Session(SessionType::BUS, settings, listener, storageType, storage, customKey)
    {}

BusSession() [2/3]

BusSession ( SessionReactor & stack, const SessionSettings & settings, SessionListener * listener, SessionStorageType::Enum storageType = SessionStorageType::FileBased, SessionStorage * storage = nullptr, const std::string & customKey = {}, const Utils::BuildInfo & = Utils::consumerBuildInfo() )

inline

Constructor.

Parameters

stack	Session reactor stack.
settings	Session settings.
listener	Session listener.
storageType	Session storage type.
storage	Session storage.
customKey	Custom key that could be used to distinguish sessions with the same UserID and ClientId values.

Definition at line 56 of file BusSession.h.

                                                                        {}, const Utils::BuildInfo & = Utils::consumerBuildInfo())
        : Session(stack, SessionType::BUS, settings, listener, storageType, storage, customKey)
    {}

BusSession() [3/3]

BusSession ( ServiceFactory & service, const SessionSettings & settings, SessionListener * listener, SessionStorageType::Enum storageType = SessionStorageType::FileBased, SessionStorage * storage = nullptr, const std::string & customKey = {}, const Utils::BuildInfo & = Utils::consumerBuildInfo() )

inline

Constructor.

Parameters

service	Service factory.
settings	Session settings.
listener	Session listener.
storageType	Session storage type.
storage	Session storage.
customKey	Custom key that could be used to distinguish sessions with the same UserID and ClientId values.

Definition at line 72 of file BusSession.h.

                                                                        {}, const Utils::BuildInfo & = Utils::consumerBuildInfo())
        : Session(service, SessionType::BUS, settings, listener, storageType, storage, customKey)
    {}

Member Function Documentation

connect()

Session & connect	(	const std::string &	host,
		Port	port )

Establishes the connection.

Parameters

host	Gateway host.
port	Gateway port.

Returns

This session.

connectAsync()

Threading::SharedFuture< void > connectAsync	(	const std::string &	host,
		Port	port )

Establishes the connection asynchronously.

Parameters

host	Gateway host.
port	Gateway port.

getBgwCredentialsAsync()

Threading::SharedFuture< BgwCredentials > getBgwCredentialsAsync ( const std::string & userId, bool forceRequest = 0 )

finalvirtual

Asynchronously provides the BGW session connection credentials for the given user id.

Parameters

userId	Gateway id.
forceRequest	If true, forces to request credentials even if they are already available.

Returns

A future to the BGW session connection credentials.

Implements IBgwCredentialsProvider.