BloombergLP::balb::PipeControlChannel

This class is a mechanism for reading control messages from a named pipe.

Synopsis

Declared in <balb_pipecontrolchannel.h>

class PipeControlChannel;

Description

Use start to spawn a thread that handles messages arriving at the pipe, and shutdown to stop reading. stop blocks until the processing thread has been terminated by a call to shutdown (either before stop is called, or from some other thread).

Type Aliases

NameDescription
ControlCallback Callback type invoked to handle control messages.

Member Functions

NameDescription
PipeControlChannel [constructor]Constructors
~PipeControlChannel [destructor]Destroy this object.
allocator Return the allocator used by this object to supply memory.
permissions Return the permission bit mask that will be applied to the named pipe on the next call to start.
pipeName Return the fully qualified system name of the pipe.
setPermissions Set the permission bit mask for the underlying named pipe.
shutdown Stop reading from the pipe and dispatching messages.
start start overloads
stop Block until the background thread has been terminated by a call to shutdown. Then close the pipe and clean up the associated file.

Static Data Members

NameDescription
k_DEFAULT_PERMISSIONS The default permission bit mask for the underlying named pipe (read/write for owner, group, and others).