Dispatch control messages to callbacks by name.

Synopsis

Declared in <balb_controlmanager.h>

class ControlManager;

Type Aliases

Name

Description

ControlHandler

Callback type invoked to handle control messages.

Member Functions

Name

Description

ControlManager [constructor]

Create a control manager object.

~ControlManager [destructor]

Destroy this object.

allocator

Return the allocator used by this object to supply memory.

deregisterDefaultHandler

Deregister the default handler for unregistered prefixes.

deregisterHandler

Deregister the handler previously registered for the specified prefix.

deregisterUsageHandler

Deregister the callback function previously registered to handle "HELP" messages (see registerUsageHandler). Return 0 on success or a non‐zero value otherwise.

dispatchMessage

dispatchMessage overloads

hasDefaultHandler

Return true if this control manager has a default message handler installed, and false otherwise.

printUsage

Print usage documentation for registered commands.

printUsageHelper

Invoke printUsage passing the specified *stream and preamble.

registerDefaultHandler

Register a handler for messages with unregistered prefixes.

registerHandler

Register a handler for messages with the specified prefix.

registerUsageHandler

Register a HELP handler that prints usage documentation.

operator BloombergLP::bslmf::NestedTraitDeclaration<ControlManager, UsesBslmaAllocator>

Declare that this type uses a bslma allocator.

Created with MrDocs