realm::networking::sync_socket_provider::timer Struct Reference

#include <websocket.hpp>

Inheritance diagram for realm::networking::sync_socket_provider::timer:

Public Member Functions
virtual	~timer ()=default
	Cancels the timer and destroys the timer instance.
virtual void	cancel ()=0

Detailed Description

The timer object used to track a timer that was started on the event loop.

This object provides a cancel() mechanism to cancel the timer. The handler function for this timer must be called with a Status of ErrorCodes::OperationAborted error code if the timer is canceled.

Custom event loop implementations will need to create a subclass of Timer that provides access to the underlying implementation to cancel the timer.

Member Function Documentation

cancel()

virtual void realm::networking::sync_socket_provider::timer::cancel ( )

pure virtual

Cancel the timer immediately. Does nothing if the timer has already expired or been cancelled.

Implemented in realm::networking::default_timer.

---

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

• include/cpprealm/networking/websocket.hpp