This is automatically generated documentation. Edit after the "COMMENTS" heading; changes to the main body will be lost.
ChatterSocket -- Click element; reports chatter messages to connected sockets
ChatterSocket("TCP", PORTNUMBER [, KEYWORDS])
ChatterSocket("UNIX", FILENAME [, KEYWORDS])
Package: userlevel (core)
Opens a chatter socket that allows other user-level programs to receive copies
of router chatter traffic. Depending on its configuration string,
ChatterSocket will listen on TCP port PORTNUMBER, or on a UNIX-domain socket
The "server" (that is, the ChatterSocket element) simply echoes any messages
generated by the router configuration to any existing "clients". The server
does not read any data from its clients.
When a connection is opened, ChatterSocket responds by stating its protocol
version number with a line like "Click::ChatterSocket/1.0\r\n". The current
version number is 1.0.
ChatterSocket broadcasts copies of messages generated by the default
ErrorHandler or the
click_chatter function. Most elements report messages
or run-time errors using one of these mechanisms.
If a client falls more than 500,000 bytes behind, ChatterSocket automatically
closes its connection.
ChatterSocket supports hot-swapping, meaning you can change configurations
without interrupting existing clients. The hot-swap will succeed only if the
old ChatterSocket and the new ChatterSocket have the same element name, and
the same socket type, port/filename, and chatter channel parameters.
Additionally, the new ChatterSocket must have RETRIES set to 1 or more, since
the old ChatterSocket has already bound the relevant socket.
Keyword arguments are:
click_chatter(). Channels help you organize extensive debugging output. For example, you could send extremely verbose messages to a `
verbose' channel, then only connect to that channel when you want verbosity. To send messages to a particular channel, you should fetch the ErrorHandler object corresponding to that channel, using the Router member function
Router::chatter_channel(const String &channel_name).
Click::ChatterSocket/1.0greeting is sent. Default is true.
Generated by 'click-elem2man' from '../elements/userlevel/chattersocket.hh' on 24/May/2007.