Skip to main content
Pigweed's logo Pigweed
code_xml
  1. Home
  2. Reference
  3. C/C++
  4. Comms
  5. pw_transport
  6. Testing
  7. pw::transport::test::BasicMockConnector< ConnectorType, kMaxQueuedResultsValue > Class Template Reference
pw::transport::test::BasicMockConnector< ConnectorType, kMaxQueuedResultsValue > Class Template Reference

Overview

template<typename ConnectorType, size_t kMaxQueuedResultsValue = 4>
class pw::transport::test::BasicMockConnector< ConnectorType, kMaxQueuedResultsValue >

Manually controlled transport connector for unit tests.

Tests feed outbound sockets or error statuses via ResolveConnect(). If a Connect() future is already waiting, ResolveConnect() resolves the oldest pending future immediately; otherwise the result is queued (up to kMaxQueuedResults) and returned by the next Connect() call.

All methods are thread-safe. On destruction, all pending Connect() futures resolve to FAILED_PRECONDITION.

Template Parameters
ConnectorTypeTransport connector interface to mock (ReliableConnector or Connector).
kMaxQueuedResultsValueMaximum number of ResolveConnect() results buffered before Connect() is called.
Inheritance diagram for pw::transport::test::BasicMockConnector< ConnectorType, kMaxQueuedResultsValue >:
pw::transport::internal::MockConnectorBase< ConnectorType, kMaxQueuedResults >

Public Types

using SocketType = typename Base::SocketType
 Socket handle type yielded by Connect() (ReliableSocket or Socket).
 

Public Member Functions

constexpr BasicMockConnector ()=default
 Creates a mock connector with no pending or queued Connect() results.
 
 ~BasicMockConnector () override=default
 
 BasicMockConnector (const BasicMockConnector &)=delete
 
BasicMockConnector & operator= (const BasicMockConnector &)=delete
 
 BasicMockConnector (BasicMockConnector &&)=delete
 
BasicMockConnector & operator= (BasicMockConnector &&)=delete
 
void ResolveConnect (Result< SocketType > result)
 
bool has_pending_connect () const
 
size_t pending_connect_count () const
 
size_t connect_count () const
 

Static Public Attributes

static constexpr size_t kMaxQueuedResults = kMaxQueuedResultsValue
 

Constructor & Destructor Documentation

◆ ~BasicMockConnector()

template<typename ConnectorType , size_t kMaxQueuedResultsValue = 4>
pw::transport::test::BasicMockConnector< ConnectorType, kMaxQueuedResultsValue >::~BasicMockConnector ( )
overridedefault

Resolves all still-pending Connect() futures with FAILED_PRECONDITION and releases any unconsumed queued sockets.

Member Function Documentation

◆ connect_count()

template<typename ConnectorType , size_t kMaxQueuedResultsValue = 4>
size_t pw::transport::test::BasicMockConnector< ConnectorType, kMaxQueuedResultsValue >::connect_count ( ) const
inline

Counts total Connect() invocations on this connector.

Returns
The total number of times Connect() has been called.

◆ has_pending_connect()

template<typename ConnectorType , size_t kMaxQueuedResultsValue = 4>
bool pw::transport::test::BasicMockConnector< ConnectorType, kMaxQueuedResultsValue >::has_pending_connect ( ) const
inline

Checks whether any Connect() future is awaiting ResolveConnect().

Returns
true if at least one Connect() future is currently pending.

◆ pending_connect_count()

template<typename ConnectorType , size_t kMaxQueuedResultsValue = 4>
size_t pw::transport::test::BasicMockConnector< ConnectorType, kMaxQueuedResultsValue >::pending_connect_count ( ) const
inline

Counts Connect() futures currently awaiting ResolveConnect().

Returns
The number of pending Connect() futures.

◆ ResolveConnect()

template<typename ConnectorType , size_t kMaxQueuedResultsValue = 4>
void pw::transport::test::BasicMockConnector< ConnectorType, kMaxQueuedResultsValue >::ResolveConnect ( Result< SocketType >  result)
inline

Resolves the oldest pending Connect() future with result, or queues result in FIFO order for the next Connect() call if none is pending.

Parameters
[in]resultSocket or error status to deliver to Connect().
Precondition
Either at least one Connect() future is pending or fewer than kMaxQueuedResults results are already queued (crash-asserts otherwise).

Member Data Documentation

◆ kMaxQueuedResults

template<typename ConnectorType , size_t kMaxQueuedResultsValue = 4>
constexpr size_t pw::transport::test::BasicMockConnector< ConnectorType, kMaxQueuedResultsValue >::kMaxQueuedResults = kMaxQueuedResultsValue
staticconstexpr

Maximum number of ResolveConnect() results buffered before Connect() is called.


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