libbmq  a5f8a06ba1d16cb5a65643e1fa7f1a1d6aadef40
bmqa_sessionevent.h File Reference

Provide value-semantic type for system event session notifications. More...

#include <bmqa_queueid.h>
#include <bmqt_correlationid.h>
#include <bmqt_sessioneventtype.h>
#include <bsl_memory.h>
#include <bsl_string.h>

Go to the source code of this file.

Classes

class  BloombergLP::bmqa::SessionEvent
 An event related to the operation of a Session. More...
 

Namespaces

 BloombergLP
 
 BloombergLP::bmqa
 

Functions

bool BloombergLP::bmqa::operator== (const SessionEvent &lhs, const SessionEvent &rhs)
 
bool BloombergLP::bmqa::operator!= (const SessionEvent &lhs, const SessionEvent &rhs)
 
bsl::ostream & BloombergLP::bmqa::operator<< (bsl::ostream &stream, const SessionEvent &rhs)
 

Detailed Description

See also
bmqt::SessionEventType: Enum of the various type of notifications

This component provides a generic bmqa::SessionEvent notification object used by the bmqa::Session to provide BlazingMQ applications with information regarding changes in the session status or the result of operations with the message queue broker.

A bmqa::SessionEvent is composed of 4 attributes:

  • type: indicate the type of the notification
  • statusCode: indicate the status of the operation (success, failure)
  • correlationId: optional correlationId used during async response
  • queueId: optional queueId associated with the event, of type OPEN, CONFIGURE, CLOSE, REOPEN
  • errorDescription: optional string with a human readable description of the error, if any

Note that bmqa::SessionEvent is implemented using the pimpl idiom, so copying a bmqa::SessionEvent is very cheap (a pointer copy). All copies of this bmqa::SessionEvent will share the same underlying implementation.