- com
- pcbsys
- nirvana
- client
- nJoinInformation
This class is a container for all the information that defines a channel join. More...
#include <nJoinInformation.h>
Inherits CountableObject.
Public Member Functions | |
bool | allowPurgeRequests () |
Returns a bool indicating if purge requests are propagated over the join link. More... | |
std::string | getDestination () |
Returns the name of the destination channel if this channel is the source of the join otherwise returns null. More... | |
int | getHopCount () |
The number of hops before the event is expired. More... | |
longlong | getLastEID () |
The last Event ID processed by this join. More... | |
std::string | getSelector () |
Returns the selector string. More... | |
std::string | getSource () |
Returns the name of the source channel if the channel is not the source of the join otherwise returns null. More... | |
bool | isArchival () |
Returns true if this join is an archival join. More... | |
bool | isSource () |
If this the source for the join or events are sent to this channel. More... | |
nJoinInformation (std::string &channelName, int hopCount, std::string &selector, bool source, longlong lastEID, bool allowPurge) | |
Constructs a nJoinInformation object containing all the required information to define a channel join. More... | |
This class is a container for all the information that defines a channel join.
com::pcbsys::nirvana::client::nJoinInformation::nJoinInformation | ( | std::string & | channelName, |
int | hopCount, | ||
std::string & | selector, | ||
bool | source, | ||
longlong | lastEID, | ||
bool | allowPurge | ||
) |
Constructs a nJoinInformation object containing all the required information to define a channel join.
channelName | The channel which this information relates to |
hopCount | The number of hops before the event is expired |
selector | The message select which controls which events are processed |
source | If this channel is the source/destination |
lastEID | The last EID processed for this join |
allowPurge | Whether purges are propagated through this join |
bool com::pcbsys::nirvana::client::nJoinInformation::allowPurgeRequests | ( | ) |
Returns a bool indicating if purge requests are propagated over the join link.
std::string com::pcbsys::nirvana::client::nJoinInformation::getDestination | ( | ) |
Returns the name of the destination channel if this channel is the source of the join otherwise returns null.
int com::pcbsys::nirvana::client::nJoinInformation::getHopCount | ( | ) |
The number of hops before the event is expired.
longlong com::pcbsys::nirvana::client::nJoinInformation::getLastEID | ( | ) |
The last Event ID processed by this join.
std::string com::pcbsys::nirvana::client::nJoinInformation::getSelector | ( | ) |
Returns the selector string.
std::string com::pcbsys::nirvana::client::nJoinInformation::getSource | ( | ) |
Returns the name of the source channel if the channel is not the source of the join otherwise returns null.
bool com::pcbsys::nirvana::client::nJoinInformation::isArchival | ( | ) |
Returns true if this join is an archival join.
bool com::pcbsys::nirvana::client::nJoinInformation::isSource | ( | ) |
If this the source for the join or events are sent to this channel.