senf::console::UDPServer Class Reference
[Accessing the Console/Config tree]

UDP Console server. More...

#include <senf/Utils/Console/UDPServer.hh>

List of all members.

Detailed Description

UDP Console server.

This class provides UDP access to the console to allow remote scripting. The UDP console does support multicast operation.

Every UDP packet will be executed in a clean context: No directory groups are open/closed, and the current directory is always the root directory.

By default, the server will send command replies via UDP to the sender of the corresponding incoming command. Replies may however either be completely disabled or be sent to a fixed address (which may be a multicast address).

Definition at line 57 of file UDPServer.hh.


Public Types
typedef
senf::ClientSocketHandle
< senf::MakeSocketPolicy
< senf::UDPv4SocketProtocol::Policy,
senf::BSDAddressingPolicy >
::policy > 		 Handle

Public Member Functions
UDPServer &  replies (bool enable)
  Enable or disable reply packets.
UDPServer &  replies (senf::INet4SocketAddress const &address)
  Send replies to address.
UDPServer &  replies (senf::INet6SocketAddress const &address)
  Send replies to address.
UDPServer &  emptyReplies (bool enable)
  Enable or disable empty reply packets.
DirectoryNode &  root () const
  Get root node.
UDPServer &  root (DirectoryNode &root)
  Set root node.

Structors and default members
  UDPServer (senf::INet4SocketAddress const &address)
  Open UDP server on address.
  UDPServer (senf::INet6SocketAddress const &address)
  Open UDP server on address.

Member Typedef Documentation

typedef senf::ClientSocketHandle< senf::MakeSocketPolicy<senf::UDPv4SocketProtocol::Policy, senf::BSDAddressingPolicy>::policy > senf::console::UDPServer::
Handle

Definition at line 68 of file UDPServer.hh.

Constructor & Destructor Documentation

senf::console::UDPServer::
UDPServer ( senf::INet4SocketAddress const &  address )

Open UDP server on address.

Definition at line 37 of file UDPServer.cc.

senf::console::UDPServer::
UDPServer ( senf::INet6SocketAddress const &  address )

Open UDP server on address.

Definition at line 51 of file UDPServer.cc.

Member Function Documentation

senf::console::UDPServer & senf::console::UDPServer::
emptyReplies ( bool  enable )

Enable or disable empty reply packets.

Default: enabled

Definition at line 88 of file UDPServer.cc.

senf::console::UDPServer & senf::console::UDPServer::
replies ( senf::INet6SocketAddress const &  address )

Send replies to address.

Default: no address set (send replies to sender)

Definition at line 80 of file UDPServer.cc.

senf::console::UDPServer & senf::console::UDPServer::
replies ( senf::INet4SocketAddress const &  address )

Send replies to address.

Default: enabled Default: no address set (send replies to sender)

Definition at line 71 of file UDPServer.cc.

senf::console::UDPServer & senf::console::UDPServer::
replies ( bool  enable )

Enable or disable reply packets.

Definition at line 64 of file UDPServer.cc.

senf::console::UDPServer & senf::console::UDPServer::
root ( DirectoryNode &  root )

Set root node.

node will be the root node for all clients launched from this server.

Definition at line 100 of file UDPServer.cc.

senf::console::DirectoryNode & senf::console::UDPServer::
root ()

Get root node.

Definition at line 94 of file UDPServer.cc.

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