tt_core_sdk::PriceSubscription Class Reference

Manages a price subscription. More...

#include <prices.hpp>

Public Member Functions
	PriceSubscription (void)
	PriceSubscription default ctor. More...
	~PriceSubscription (void) noexcept
	PriceSubscription dtor. More...
uint64_t	Id (void) const noexcept
	Unique PriceSubscription ID. More...
bool	IsValid (void) const noexcept
	Check if the subscription is valid. More...
	PriceSubscription (const PriceSubscription &)=delete
	Non-copyable, move enabled. More...
PriceSubscription &	operator= (const PriceSubscription &)=delete
	PriceSubscription (PriceSubscription &&) noexcept
PriceSubscription &	operator= (PriceSubscription &&) noexcept
void	Pause (void)
	PriceSubscription Controls. More...
bool	Resume (void)
void	Cancel (void)
Filter	GetFilter (void) const noexcept
	PriceSubscription Filter. More...
void	SetFilter (const Filter &filter) noexcept
	Overwrites filter. More...
void	AddFilter (const Filter &additional_filter) noexcept
class	PriceLibImpl
	Internal. More...
class	InProcessComposerImpl
class	InProcessUnifierImpl
class	InProcessPriceTCPImpl
class	PriceClientTCP

Detailed Description

Manages a price subscription.

Controller for a price subscription. A valid subscription cannot be constructed, but is provided by CreatePriceSubscription.

Note

The subscription will be closed when the instance is destroyed. Keep this object in scope for the duration of your price subscription.

Definition at line 209 of file prices.hpp.

Constructor & Destructor Documentation

PriceSubscription() [1/3]

tt_core_sdk::PriceSubscription::PriceSubscription

(

void

)

PriceSubscription default ctor.

Default contucts an invalid object, allowing use as a member variable to later assign the result from CreatePriceSubscription.

~PriceSubscription()

tt_core_sdk::PriceSubscription::~PriceSubscription ( void  )

noexcept

PriceSubscription dtor.

Price subscription is closed

PriceSubscription() [2/3]

tt_core_sdk::PriceSubscription::PriceSubscription ( const PriceSubscription &  )

delete

Non-copyable, move enabled.

PriceSubscription() [3/3]

tt_core_sdk::PriceSubscription::PriceSubscription ( PriceSubscription &&  )

noexcept

Member Function Documentation

AddFilter()

void tt_core_sdk::PriceSubscription::AddFilter ( const Filter &  additional_filter )

noexcept

Appends to existing filter

Cancel()

void tt_core_sdk::PriceSubscription::Cancel

(

void

)

GetFilter()

Filter tt_core_sdk::PriceSubscription::GetFilter ( void  ) const

noexcept

PriceSubscription Filter.

Manages the filters for this price subscription. See the Filter details for further information and pre-defined filters.

Id()

uint64_t tt_core_sdk::PriceSubscription::Id ( void  ) const

inlinenoexcept

Unique PriceSubscription ID.

Definition at line 229 of file prices.hpp.

IsValid()

bool tt_core_sdk::PriceSubscription::IsValid ( void  ) const

noexcept

Check if the subscription is valid.

Invalid objects result from a failed CreatePriceSubscription request, or objects which have been default constructed.

operator=() [1/2]

PriceSubscription& tt_core_sdk::PriceSubscription::operator= ( const PriceSubscription &  )

delete

operator=() [2/2]

PriceSubscription& tt_core_sdk::PriceSubscription::operator= ( PriceSubscription &&  )

noexcept

Pause()

void tt_core_sdk::PriceSubscription::Pause

(

void

)

PriceSubscription Controls.

Pause/Resume controls whether subscription updates are delivered to the listener. Cancelling the subscription removes the listener from the list of observers and can no longer be resumed. Cancelling should only be performed when the subscription is no longer desired.

Resume()

bool tt_core_sdk::PriceSubscription::Resume

(

void

)

SetFilter()

void tt_core_sdk::PriceSubscription::SetFilter ( const Filter &  filter )

noexcept

Overwrites filter.

Friends And Related Function Documentation

InProcessComposerImpl

friend class InProcessComposerImpl

friend

Definition at line 259 of file prices.hpp.

InProcessPriceTCPImpl

friend class InProcessPriceTCPImpl

friend

Definition at line 261 of file prices.hpp.

InProcessUnifierImpl

friend class InProcessUnifierImpl

friend

Definition at line 260 of file prices.hpp.

PriceClientTCP

friend class PriceClientTCP

friend

Definition at line 262 of file prices.hpp.

PriceLibImpl

friend class PriceLibImpl

friend

Internal.

Definition at line 258 of file prices.hpp.

---

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

• Header Files/prices.hpp