join 1.0
lightweight network framework library
Loading...
Searching...
No Matches
Inbox< Message > Class Template Reference

messages received by a listener. More...

Public Member Functions

void push (const Message &message)
 record a message.
 
bool awaits (size_t count, std::chrono::milliseconds timeout=std::chrono::seconds(5))
 wait for the given number of messages to be received.
 
std::vector< Message > messages ()
 get the messages received.
 

Detailed Description

template<class Message>
class Inbox< Message >

messages received by a listener.

Member Function Documentation

◆ awaits()

template<class Message >
bool Inbox< Message >::awaits ( size_t count,
std::chrono::milliseconds timeout = std::chrono::seconds (5) )
inline

wait for the given number of messages to be received.

Parameters
countnumber of messages.
timeoutwait timeout.
Returns
true if they were received, false if it timed out.

◆ messages()

template<class Message >
std::vector< Message > Inbox< Message >::messages ( )
inline

get the messages received.

Returns
the messages received.

◆ push()

template<class Message >
void Inbox< Message >::push ( const Message & message)
inline

record a message.

Parameters
messagemessage received.

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