Audacity 3.2.0
Public Member Functions | List of all members
IPCChannelStatusCallback Class Referenceabstract

Interface for listening connection status changes. More...

#include <IPCChannel.h>

Inheritance diagram for IPCChannelStatusCallback:
[legend]

Public Member Functions

virtual ~IPCChannelStatusCallback ()
 
virtual void OnConnectionError () noexcept=0
 Called when connection attempt fails. More...
 
virtual void OnConnect (IPCChannel &channel) noexcept=0
 Called when connection established. More...
 
virtual void OnDisconnect () noexcept=0
 Invalidates IPCChannel passed as argument in OnConnect. More...
 
virtual void OnDataAvailable (const void *data, size_t size) noexcept=0
 Called when data chunk received as a result of a preceding call to IPCChannel::Send. Generally, data pointer should not be accessed outside this method, copied if necessary. More...
 

Detailed Description

Interface for listening connection status changes.

Definition at line 36 of file IPCChannel.h.

Constructor & Destructor Documentation

◆ ~IPCChannelStatusCallback()

IPCChannelStatusCallback::~IPCChannelStatusCallback ( )
virtualdefault

Member Function Documentation

◆ OnConnect()

virtual void IPCChannelStatusCallback::OnConnect ( IPCChannel channel)
pure virtualnoexcept

Called when connection established.

Parameters
channelUsing this channel client or server can send data to the other side.

Implemented in AsyncPluginValidator::Impl, and PluginHost.

Referenced by BufferedIPCChannel::StartConversation().

Here is the caller graph for this function:

◆ OnConnectionError()

virtual void IPCChannelStatusCallback::OnConnectionError ( )
pure virtualnoexcept

Called when connection attempt fails.

Implemented in AsyncPluginValidator::Impl, and PluginHost.

Referenced by IPCClient::Impl::Impl(), and IPCServer::Impl::Impl().

Here is the caller graph for this function:

◆ OnDataAvailable()

virtual void IPCChannelStatusCallback::OnDataAvailable ( const void *  data,
size_t  size 
)
pure virtualnoexcept

Called when data chunk received as a result of a preceding call to IPCChannel::Send. Generally, data pointer should not be accessed outside this method, copied if necessary.

Parameters
dataPointer to the chunk
sizeSize of the chunk

Implemented in AsyncPluginValidator::Impl, and PluginHost.

Referenced by BufferedIPCChannel::StartConversation().

Here is the caller graph for this function:

◆ OnDisconnect()

virtual void IPCChannelStatusCallback::OnDisconnect ( )
pure virtualnoexcept

Invalidates IPCChannel passed as argument in OnConnect.

Implemented in AsyncPluginValidator::Impl, and PluginHost.

Referenced by BufferedIPCChannel::StartConversation().

Here is the caller graph for this function:

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