Class CListener

• Defined in File listener.h

Inheritance Relationships

Base Types

• public sdv::CSdvObject (Class CSdvObject)

• public sdv::IObjectControl (Struct IObjectControl)

Class Documentation

class CListener : public sdv::CSdvObject, public sdv::IObjectControl

Listener object.

Public Functions

CListener()

Default constructor.

virtual void Initialize(const sdv::u8string &ssObjectConfig) override

Initialize the object. Overload of sdv::IObjectControl::Initialize.

The object configuration contains the information needed to start the listener. The following configuration is available for the local listener:

[Listener]
Type = "Local"
Instance = 1000    # Normally not used; system instance ID is used automatically.

And the following is available for a remote listener:

[Listener]
Type = "Remote"
Interface = "127.0.0.1"
Port = 2000

Parameters:

ssObjectConfig – [in] Optional configuration string.

virtual sdv::EObjectStatus GetStatus() const override

Get the current status of the object. Overload of sdv::IObjectControl::GetStatus.

Returns:

Return the current status of the object.

virtual void SetOperationMode(sdv::EOperationMode eMode) override

Set the component operation mode. Overload of sdv::IObjectControl::SetOperationMode.

Parameters:

eMode – [in] The operation mode, the component should run in.

virtual void Shutdown() override

Shutdown called before the object is destroyed. Overload of sdv::IObjectControl::Shutdown.

bool IsLocalListener() const

When set, the listener is configured to be a local listener. Otherwise the listerner is configured as remote listener.

Returns:

Boolean set when local lostener.