Class Poco::Remoting::Binary::Listener

Library: Remoting/Binary
Package: Binary
Header: Poco/Remoting/Binary/Listener.h

Description

This class implements the Listener for the Binary Transport.

The listener uses a Poco::Net::TCPServer to accept incoming connections.

Inheritance

Direct Base Classes: Poco::Remoting::Listener

All Base Classes: Poco::Remoting::Listener

Member Summary

Member Functions: getTransportId, invoke, registerObject, start, stop, unregisterObject

Inherited Functions: getLocalEndPoint, getTransportId, registerObject, start, stop, unregisterObject

Constructors

Listener

Listener(
Poco::UInt16 port,
Poco::Net::TCPServerParams::Ptr pParams = 0
);

Creates the Listener for the given port number.

A Poco::Net::TCPServer is set up using a Poco::Net::ServerSocket for the given port number and the Poco::Net::TCPServerParams object.

Listener

Listener(
const Poco::Net::ServerSocket & sock,
Poco::Net::TCPServerParams::Ptr pParams = 0
);

Creates the listener using the given server socket.

If the given socket is a Poco::Net::SecureServerSocket, the listener uses a secure SSL/TLS connection.

A Poco::Net::TCPServer is set up using the given server socket and Poco::Net::TCPServerParams object.

Destructor

~Listener

Destroys the Listener.

Member Functions

getTransportId

const std::string & getTransportId() const;

Returns the transportId.

See also: Poco::Remoting::Listener::getTransportId()

invoke

bool invoke(
BinaryStream & stream,
Poco::Remoting::Transport & trans
);

Returns false if a fatal error occurs, fatal errors are errors which require to close the connection immediately, an exception while executing is not fatal and will be consumed by this method

registerObject

void registerObject(
    Poco::AutoPtr < Poco::Remoting::RemoteObject > ptrObj,
    Poco::AutoPtr < Poco::Remoting::Skeleton > ptrSkel,
    const Poco::Remoting::Identifiable::ObjectId & oid,
    const Poco::Remoting::Identifiable::TypeId & tid,
    bool secure
);

Adds an object to the listener. Depending on the protocol, the Listener can opt to let the ORB handle all invocations (i.e we have a protocol where we can send the fullURI with the request, which allows to implement a requesthandler that simply calls ORB::invoke. In this case, registerObject and unregisterObject can have an empty implementation.

start

void start();

Starts accepting requests.

See also: Poco::Remoting::Listener::start()

stop

void stop();

Stops accepting requests.

See also: Poco::Remoting::Listener::stop()

unregisterObject

void unregisterObject(
Poco::AutoPtr < Poco::Remoting::RemoteObject > ptrObj
);

Unregisters the given object.