Public Member Functions | Protected Member Functions | List of all members
swarmio::services::ErrorAwaiter Class Referencefinal

An Awaiter that checks whether the operation was a success. More...

#include <ErrorAwaiter.h>

Inheritance diagram for swarmio::services::ErrorAwaiter:
Inheritance graph
[legend]

Public Member Functions

 ErrorAwaiter (Endpoint *endpoint, uint64_t requestIdentifier)
 Construct a new ErrorAwaiter object. More...
 
- Public Member Functions inherited from swarmio::services::Awaiter< bool >
 Awaiter (Endpoint *endpoint, uint64_t requestIdentifier)
 Construct a new ResponseAwaiter object. More...
 
 Awaiter (const bool &value)
 Construct an awaiter with a cached value. More...
 
 Awaiter (Awaiter &&other)
 Move an Awaiter object. More...
 
uint64_t GetIdentifier () const
 Get request identifier. More...
 
bool GetResponse ()
 Get the response value. Will throw an exception if called before the response is received. More...
 
bool HasException ()
 Checks whether the result of the processing has ended with an exception. More...
 
virtual bool ReceiveMessage (const Node *sender, const data::Message *message) override
 Delivery point of all messages. More...
 
bool WaitForResponse (const std::chrono::milliseconds &timeout)
 Wait for the response to become available or util the timeout period ellapses. More...
 
- Public Member Functions inherited from swarmio::Mailbox
virtual void Disconnect ()
 Disconnect this Mailbox from the Endpoint. More...
 
EndpointGetEndpoint ()
 Get the associated Endpoint. More...
 
 Mailbox (const Mailbox &)=delete
 Remove copy constructor. More...
 
virtual void MailboxWasConnected () noexcept
 Called when the mailbox is attached to an already running endpoint or if the attached endpoint has just started. More...
 
virtual void MailboxWillBeDisconnected () noexcept
 Called right before the mailbox is disconnected from its endpoint or if the attached endpoint is about to stop. More...
 
virtual void NodeDidJoin (const Node *node) noexcept
 Called when a new Node has joined the group. More...
 
virtual void NodeWasDiscovered (const Node *node) noexcept
 Called when a new Node has been discovered. More...
 
virtual void NodeWillLeave (const Node *node) noexcept
 Called when a Node signals that it will leave. More...
 
Mailboxoperator= (const Mailbox &)=delete
 Remove assignment operator. More...
 
virtual ~Mailbox ()
 Destroy the Mailbox object. More...
 

Protected Member Functions

virtual bool ExtractResponse (const Node *node, const data::Message *message) override
 Called when a response for the original message has been received. More...
 
- Protected Member Functions inherited from swarmio::services::Awaiter< bool >
virtual bool IsFinished ()
 Check whether the last message has been received. More...
 
- Protected Member Functions inherited from swarmio::Mailbox
void FinishConstruction ()
 Called when the last constructor has finished its job. More...
 
void FinishMovingTo (Mailbox *other)
 Called when message handling should be passed onto the new instance. More...
 
 Mailbox ()
 Construct a disconnected Mailbox. More...
 
 Mailbox (Endpoint *endpoint)
 Construct a new Mailbox object. More...
 
 Mailbox (Mailbox &&other)
 Move a Mailbox object. More...
 

Detailed Description

An Awaiter that checks whether the operation was a success.

Definition at line 11 of file ErrorAwaiter.h.

Constructor & Destructor Documentation

swarmio::services::ErrorAwaiter::ErrorAwaiter ( Endpoint endpoint,
uint64_t  requestIdentifier 
)
inline

Construct a new ErrorAwaiter object.

Parameters
endpointEndpoint
requestIdentifierOriginal message identifier

Definition at line 32 of file ErrorAwaiter.h.

Member Function Documentation

bool ErrorAwaiter::ExtractResponse ( const Node node,
const data::Message *  message 
)
overrideprotectedvirtual

Called when a response for the original message has been received.

Parameters
nodeSender node
messageMessage

Implements swarmio::services::Awaiter< bool >.

Definition at line 7 of file ErrorAwaiter.cpp.


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


swarmros
Author(s):
autogenerated on Fri Apr 3 2020 03:42:48