Implementation of a half-duplex line oriented telnet connection. More...

#include <tsTelnetConnection.h>

Inheritance diagram for ts::TelnetConnection:

[legend]

Collaboration diagram for ts::TelnetConnection:

[legend]

Public Types
using	SuperClass = TCPConnection
	Reference to the superclass.

Public Member Functions
	TelnetConnection (const std::string &prompt=std::string())
	Constructor.

virtual	~TelnetConnection () override
	Virtual destructor.

bool	bind (const IPv4SocketAddress &addr, Report &report=(ts::CerrReport::Instance()))
	Bind to a local address and port.

virtual bool	close (Report &report=(ts::CerrReport::Instance())) override
	Close the socket.

bool	closeWriter (Report &report=(ts::CerrReport::Instance()))
	Close the write direction of the connection.

bool	connect (const IPv4SocketAddress &addr, Report &report=(ts::CerrReport::Instance()))
	Connect to a remote address and port.

bool	debug () const
	Check if debugging is active.

template<class... Args>
void	debug (const UChar *fmt, Args &&... args)
	Report a debug message with a printf-like interface.

void	debug (const UChar *msg)
	Report a debug message.

template<class... Args>
void	debug (const UString &fmt, Args &&... args)
	Report a debug message with a printf-like interface.

void	debug (const UString &msg)
	Report a debug message.

Report *	delegateReport (Report *report)
	Delegate message logging to another report object.

bool	disconnect (Report &report=(ts::CerrReport::Instance()))
	Disconnect from remote partner.

template<class... Args>
void	error (const UChar *fmt, Args &&... args)
	Report an error message with a printf-like interface.

void	error (const UChar *msg)
	Report an error message.

template<class... Args>
void	error (const UString &fmt, Args &&... args)
	Report an error message with a printf-like interface.

void	error (const UString &msg)
	Report an error message.

template<class... Args>
void	fatal (const UChar *fmt, Args &&... args)
	Report a fatal error message with a printf-like interface.

void	fatal (const UChar *msg)
	Report a fatal error message.

template<class... Args>
void	fatal (const UString &fmt, Args &&... args)
	Report a fatal error message with a printf-like interface.

void	fatal (const UString &msg)
	Report a fatal error message.

bool	getLocalAddress (IPv4SocketAddress &addr, Report &report=(ts::CerrReport::Instance()))
	Get local socket address.

bool	getPeer (IPv4SocketAddress &addr, Report &report=(ts::CerrReport::Instance())) const
	Get the connected remote peer.

SysSocketType	getSocket () const
	Get the underlying socket device handle (use with care).

bool	gotErrors () const
	Check if errors (or worse) were reported through this object.

template<class... Args>
void	info (const UChar *fmt, Args &&... args)
	Report an informational message with a printf-like interface.

void	info (const UChar *msg)
	Report an informational message.

template<class... Args>
void	info (const UString &fmt, Args &&... args)
	Report an informational message with a printf-like interface.

void	info (const UString &msg)
	Report an informational message.

bool	isConnected () const
	Check if the socket is connected.

bool	isOpen () const
	Check if socket is open.

template<class... Args>
void	log (int severity, const UChar *fmt, Args &&... args)
	Report a message with an explicit severity and a printf-like interface.

template<class... Args>
void	log (int severity, const UString &fmt, Args &&... args)
	Report a message with an explicit severity and a printf-like interface.

void	log (int severity, const UString &msg)
	Report a message with an explicit severity.

int	maxSeverity () const
	Get maximum severity level.

virtual bool	open (Report &report=(ts::CerrReport::Instance())) override
	Open the socket.

UString	peerName () const
	Get the connected remote peer as a string.

void	raiseMaxSeverity (int level)
	Raise maximum severity level.

bool	receive (std::string &data, const AbortInterface *abort, Report &report)
	Receive character data.

bool	receive (UString &data, const AbortInterface *abort, Report &report)
	Receive character data.

bool	receive (void buffer, size_t max_size, size_t &ret_size, const AbortInterface abort=nullptr, Report &report=(ts::CerrReport::Instance()))
	Receive data.

bool	receive (void buffer, size_t size, const AbortInterface abort=nullptr, Report &report=(ts::CerrReport::Instance()))
	Receive data until buffer is full.

bool	receiveLine (std::string &line, const AbortInterface *abort, Report &report)
	Receive a line.

bool	receiveLine (UString &line, const AbortInterface *abort, Report &report)
	Receive a line.

UString	reportPrefix () const
	Get the current prefix to display.

void	resetErrors ()
	Reset the error indicator.

bool	reusePort (bool reuse_port, Report &report=(ts::CerrReport::Instance()))
	Set the "reuse port" option.

bool	send (const std::string &str, Report &report)
	Send a string to the server.

bool	send (const UString &str, Report &report)
	Send a string to the server.

bool	send (const void *data, size_t size, Report &report=(ts::CerrReport::Instance()))
	Send data.

bool	sendLine (const std::string &str, Report &report)
	Send a text line to the server.

bool	sendLine (const UString &str, Report &report)
	Send a text line to the server.

bool	setKeepAlive (bool active, Report &report=(ts::CerrReport::Instance()))
	Set the "keep alive" option.

bool	setLingerTime (int seconds, Report &report=(ts::CerrReport::Instance()))
	Set the linger time option.

void	setMaxSeverity (int level)
	Set maximum severity level.

bool	setNoDelay (bool active, Report &report=(ts::CerrReport::Instance()))
	Set the "no delay" option.

bool	setNoLinger (Report &report=(ts::CerrReport::Instance()))
	Remove the linger time option.

bool	setReceiveBufferSize (size_t size, Report &report=(ts::CerrReport::Instance()))
	Set the receive buffer size.

bool	setReceiveTimeout (cn::milliseconds timeout, Report &report=(ts::CerrReport::Instance()))
	Set the receive timeout.

void	setReportPrefix (const UString &prefix)
	Set the prefix to display before each message.

bool	setSendBufferSize (size_t size, Report &report=(ts::CerrReport::Instance()))
	Set the send buffer size.

bool	setTTL (int ttl, Report &report=(ts::CerrReport::Instance()))
	Set the Time To Live (TTL) option.

template<class... Args>
void	severe (const UChar *fmt, Args &&... args)
	Report a severe error message with a printf-like interface.

void	severe (const UChar *msg)
	Report a severe error message.

template<class... Args>
void	severe (const UString &fmt, Args &&... args)
	Report a severe error message with a printf-like interface.

void	severe (const UString &msg)
	Report a severe error message.

bool	verbose () const
	Check if verbose reporting is active.

template<class... Args>
void	verbose (const UChar *fmt, Args &&... args)
	Report a verbose message with a printf-like interface.

void	verbose (const UChar *msg)
	Report a verbose message.

template<class... Args>
void	verbose (const UString &fmt, Args &&... args)
	Report a verbose message with a printf-like interface.

void	verbose (const UString &msg)
	Report a verbose message.

bool	waitForPrompt (const AbortInterface *abort, Report &report)
	Receive a prompt.

template<class... Args>
void	warning (const UChar *fmt, Args &&... args)
	Report a warning message with a printf-like interface.

void	warning (const UChar *msg)
	Report a warning error message.

template<class... Args>
void	warning (const UString &fmt, Args &&... args)
	Report a warning message with a printf-like interface.

void	warning (const UString &msg)
	Report a warning error message.

Static Public Attributes
static const std::string	EOL
	A telnet end-of-line sequence.

Protected Member Functions
bool	createSocket (int domain, int type, int protocol, Report &report)
	Create the socket.

virtual void	declareOpened (SysSocketType sock, Report &report) override
	Set an open socket descriptor from a subclass.

virtual void	handleClosed (Report &report=(ts::CerrReport::Instance())) override
	This virtual method can be overriden by subclasses to be notified of close.

virtual void	handleConnected (Report &report=(ts::CerrReport::Instance()))
	This virtual method can be overriden by subclasses to be notified of connection.

virtual void	handleDisconnected (Report &report=(ts::CerrReport::Instance()))
	This virtual method can be overriden by subclasses to be notified of disconnection.

virtual void	handleOpened (Report &report)
	This virtual method can be overriden by subclasses to be notified of open.

virtual void	writeLog (int severity, const UString &msg) override
	Actual message reporting method.

Protected Attributes
std::recursive_mutex	_mutex {}
	Mutex protecting this object.

Detailed Description

Implementation of a half-duplex line oriented telnet connection.

This class supports the communication with a half-duplex line oriented telnet server:

The server sends a prompt.
The client sends a request.
The server replies by one or more lines followed by the prompt.

From the client point of view the interface must allow:

To send a request.
To get replies line until all the lines of the replies have been read.

This class is also a subclass of Report, allowing it to be used to end log messages.

Constructor & Destructor Documentation

◆ TelnetConnection()

ts::TelnetConnection::TelnetConnection ( const std::string & prompt = std::string() )

Constructor.

Parameters

[in] prompt Prompt string to send to the client.

Member Function Documentation

◆ send() [1/3]

bool ts::TelnetConnection::send	(	const std::string &	str,
		Report &	report
	)

Send a string to the server.

Parameters

[in]	str	The string to send to the server.
[in,out]	report	Where to report errors.

Returns: True on success, false on error.

◆ send() [2/3]

bool ts::TelnetConnection::send	(	const UString &	str,
		Report &	report
	)

Send a string to the server.

Parameters

[in]	str	The string to send to the server.
[in,out]	report	Where to report errors.

Returns: True on success, false on error.

◆ sendLine() [1/2]

bool ts::TelnetConnection::sendLine	(	const std::string &	str,
		Report &	report
	)

Send a text line to the server.

Parameters

[in]	str	The line to send to the server.
[in,out]	report	Where to report errors.

Returns: True on success, false on error.

◆ sendLine() [2/2]

bool ts::TelnetConnection::sendLine	(	const UString &	str,
		Report &	report
	)

Send a text line to the server.

Parameters

[in]	str	The line to send to the server.
[in,out]	report	Where to report errors.

Returns: True on success, false on error.

◆ receive() [1/4]

bool ts::TelnetConnection::receive	(	std::string &	data,
		const AbortInterface *	abort,
		Report &	report
	)

Receive character data.

Parameters

[out]	data	The received data.
[in]	abort	If non-zero, invoked when I/O is interrupted (in case of user-interrupt, return, otherwise retry).
[in,out]	report	Where to report errors.

Returns: True on success, false on error. Return true until the last line of the replies has been received.

◆ receive() [2/4]

bool ts::TelnetConnection::receive	(	UString &	data,
		const AbortInterface *	abort,
		Report &	report
	)

Receive character data.

Parameters

[out]	data	The received data.
[in]	abort	If non-zero, invoked when I/O is interrupted (in case of user-interrupt, return, otherwise retry).
[in,out]	report	Where to report errors.

Returns: True on success, false on error. Return true until the last line of the replies has been received.

◆ receiveLine() [1/2]

bool ts::TelnetConnection::receiveLine	(	std::string &	line,
		const AbortInterface *	abort,
		Report &	report
	)

Receive a line.

Parameters

[out]	line	The received line.
[in]	abort	If non-zero, invoked when I/O is interrupted (in case of user-interrupt, return, otherwise retry).
[in,out]	report	Where to report errors.

Returns: True on success, false on error. Return true until the last line of the replies has been received.

◆ receiveLine() [2/2]

bool ts::TelnetConnection::receiveLine	(	UString &	line,
		const AbortInterface *	abort,
		Report &	report
	)

Receive a line.

Parameters

[out]	line	The received line.
[in]	abort	If non-zero, invoked when I/O is interrupted (in case of user-interrupt, return, otherwise retry).
[in,out]	report	Where to report errors.

Returns: True on success, false on error. Return true until the last line of the replies has been received.

◆ waitForPrompt()

bool ts::TelnetConnection::waitForPrompt	(	const AbortInterface *	abort,
		Report &	report
	)

Receive a prompt.

Do not wait if the prompt is empty.

Parameters

[in]	abort	If non-zero, invoked when I/O is interrupted (in case of user-interrupt, return, otherwise retry).
[in,out]	report	Where to report errors.

Returns: True on success, false on error.

◆ writeLog()

virtual void ts::TelnetConnection::writeLog	(	int	severity,
		const UString &	msg
	)

overrideprotectedvirtual

Actual message reporting method.

The method is called only when a message passed the severity filter. It is not necessary to recheck the maximum severity inside the method. By default, does nothing.

Parameters

[in]	severity	Message severity.
[in]	msg	Message text.

Reimplemented from ts::Report.

◆ connect()

bool ts::TCPConnection::connect	(	const IPv4SocketAddress &	addr,
		Report &	report = `(ts::CerrReport::Instance())`
	)

inherited

Connect to a remote address and port.

Use this method when acting as TCP client. Do not use on server side: the TCPConnection object is passed to TCPServer::accept() which establishes the connection.

Parameters

[in]	addr	IP address and port of the server to connect.
[in,out]	report	Where to report error.

Returns: True on success, false on error.

◆ isConnected()

bool ts::TCPConnection::isConnected ( ) const

inlineinherited

Check if the socket is connected.

Returns: True if the socket was successfully connected to the peer.

◆ getPeer()

bool ts::TCPConnection::getPeer	(	IPv4SocketAddress &	addr,
		Report &	report = `(ts::CerrReport::Instance())`
	)		const

inherited

Get the connected remote peer.

Parameters

[out]	addr	IP address and port of the remote socket.
[in,out]	report	Where to report error.

Returns: True on success, false on error.

◆ peerName()

UString ts::TCPConnection::peerName ( ) const

inherited

Get the connected remote peer as a string.

Returns: A string representation of the IP address and port of the remote socket.

◆ closeWriter()

bool ts::TCPConnection::closeWriter ( Report & report = (ts::CerrReport::Instance()) )

inherited

Close the write direction of the connection.

The application shall call this routine after sending the last message but may still want to receive messages, waiting for the peer to voluntary disconnect.

Parameters

[in,out] report Where to report error.

Returns: True on success, false on error.

◆ disconnect()

bool ts::TCPConnection::disconnect ( Report & report = (ts::CerrReport::Instance()) )

inherited

Disconnect from remote partner.

Parameters

[in,out] report Where to report error.

Returns: True on success, false on error.

◆ send() [3/3]

bool ts::TCPConnection::send	(	const void *	data,
		size_t	size,
		Report &	report = `(ts::CerrReport::Instance())`
	)

inherited

Send data.

Parameters

[in]	data	Address of the data to send.
[in]	size	Size in bytes of the data to send.
[in,out]	report	Where to report error.

Returns: True on success, false on error.

◆ receive() [3/4]

bool ts::TCPConnection::receive	(	void *	buffer,
		size_t	max_size,
		size_t &	ret_size,
		const AbortInterface *	abort = `nullptr`,
		Report &	report = `(ts::CerrReport::Instance())`
	)

inherited

Receive data.

This version of receive() returns when "some" data are received into the user buffer. The actual received data may be shorter than the user buffer size.

The version is typically useful when the application cannot predict how much data will be received and must respond even if the user buffer is not full.

Parameters

[out]	buffer	Address of the buffer for the received data.
[in]	max_size	Size in bytes of the reception buffer.
[out]	ret_size	Size in bytes of the received data. Will never be larger than max_size.
[in]	abort	If non-zero, invoked when I/O is interrupted (in case of user-interrupt, return, otherwise retry).
[in,out]	report	Where to report error.

Returns: True on success, false on error.

◆ receive() [4/4]

bool ts::TCPConnection::receive	(	void *	buffer,
		size_t	size,
		const AbortInterface *	abort = `nullptr`,
		Report &	report = `(ts::CerrReport::Instance())`
	)

inherited

Receive data until buffer is full.

This version of receive() returns only when sufficient data are received to completely fill the user buffer. The size of the actual received data is identical to the user buffer size.

The version is typically useful when the application knows that a certain amount of data is expected and must wait for them.

Parameters

[out]	buffer	Address of the buffer for the received data.
[in]	size	Size in bytes of the buffer.
[in]	abort	If non-zero, invoked when I/O is interrupted (in case of user-interrupt, return, otherwise retry).
[in,out]	report	Where to report error.

Returns: True on success, false on error.

◆ handleConnected()

virtual void ts::TCPConnection::handleConnected ( Report & report = (ts::CerrReport::Instance()) )

protectedvirtualinherited

This virtual method can be overriden by subclasses to be notified of connection.

All subclasses should explicitly invoke their superclass' handlers.

Parameters

[in,out] report Where to report error.

Reimplemented in ts::tlv::Connection< SAFETY >, ts::tlv::Connection< ThreadSafety::Full >, and ts::tlv::Connection< ThreadSafety::None >.

◆ handleDisconnected()

virtual void ts::TCPConnection::handleDisconnected ( Report & report = (ts::CerrReport::Instance()) )

protectedvirtualinherited

This virtual method can be overriden by subclasses to be notified of disconnection.

All subclasses should explicitly invoke their superclass' handlers.

Parameters

[in,out] report Where to report error.

◆ handleClosed()

virtual void ts::TCPConnection::handleClosed ( Report & report = (ts::CerrReport::Instance()) )

overrideprotectedvirtualinherited

This virtual method can be overriden by subclasses to be notified of close.

All subclasses should explicitly invoke their superclass' handlers.

Parameters

[in,out] report Where to report error.

Reimplemented from ts::TCPSocket.

◆ setTTL()

bool ts::TCPSocket::setTTL	(	int	ttl,
		Report &	report = `(ts::CerrReport::Instance())`
	)

inherited

Set the Time To Live (TTL) option.

Parameters

[in]	ttl	The TTL value, ie. the maximum number of "hops" between routers before an IP packet is dropped.
[in,out]	report	Where to report error.

Returns: True on success, false on error.

◆ setNoLinger()

bool ts::TCPSocket::setNoLinger ( Report & report = (ts::CerrReport::Instance()) )

inherited

Remove the linger time option.

Parameters

[in,out] report Where to report error.

Returns: True on success, false on error.

◆ setLingerTime()

bool ts::TCPSocket::setLingerTime	(	int	seconds,
		Report &	report = `(ts::CerrReport::Instance())`
	)

inherited

Set the linger time option.

Parameters

[in]	seconds	Number of seconds to wait after shuting down the socket.
[in,out]	report	Where to report error.

Returns: True on success, false on error.

◆ setKeepAlive()

bool ts::TCPSocket::setKeepAlive	(	bool	active,
		Report &	report = `(ts::CerrReport::Instance())`
	)

inherited

Set the "keep alive" option.

Parameters

[in]	active	If true, the socket periodically sends "keep alive" packets when the connection is idle.
[in,out]	report	Where to report error.

Returns: True on success, false on error.

◆ setNoDelay()

bool ts::TCPSocket::setNoDelay	(	bool	active,
		Report &	report = `(ts::CerrReport::Instance())`
	)

inherited

Set the "no delay" option.

Parameters

[in]	active	If true, the socket immediately sends outgoing packets. By default, a TCP socket waits a small amount of time after a send() operation to get a chance to group outgoing data from successive send() operations into one single packet.
[in,out]	report	Where to report error.

Returns: True on success, false on error.

◆ bind()

bool ts::TCPSocket::bind	(	const IPv4SocketAddress &	addr,
		Report &	report = `(ts::CerrReport::Instance())`
	)

inherited

Bind to a local address and port.

The IP address part of the socket address must one of:

IPv4Address::AnyAddress. Any local interface may be used to connect to a server (client side) or to receive incoming client connections (server side).
The IP address of an interface of the local system. Outgoing connections (client side) will be only allowed through this interface. Incoming client connections (server side) will be accepted only when they arrive through the selected interface.

The port number part of the socket address must be one of:

IPv4SocketAddress::AnyPort. The socket is bound to an arbitrary unused local TCP port. This is the usual configuration for a TCP client.
A specific port number. This is the usual configuration for a TCP server. If this TCP port is already bound by another local TCP socket, the bind operation fails, unless the "reuse port" option has already been set.

Parameters

[in]	addr	Local socket address to bind to.
[in,out]	report	Where to report error.

Returns: True on success, false on error.

◆ open()

virtual bool ts::TCPSocket::open ( Report & report = (ts::CerrReport::Instance()) )

overridevirtualinherited

Open the socket.

Parameters

[in,out] report Where to report error.

Returns: True on success, false on error.

Implements ts::Socket.

◆ close()

virtual bool ts::TCPSocket::close ( Report & report = (ts::CerrReport::Instance()) )

overridevirtualinherited

Close the socket.

Parameters

[in,out] report Where to report error.

Returns: True on success, false on error.

Reimplemented from ts::Socket.

Reimplemented in ts::TCPServer.

◆ handleOpened()

virtual void ts::TCPSocket::handleOpened ( Report & report )

protectedvirtualinherited

This virtual method can be overriden by subclasses to be notified of open.

All subclasses should explicitly invoke their superclass' handlers.

Parameters

[in,out] report Where to report error.

◆ declareOpened()

virtual void ts::TCPSocket::declareOpened	(	SysSocketType	sock,
		Report &	report
	)

overrideprotectedvirtualinherited

Set an open socket descriptor from a subclass.

This method is used by a server to declare that a client socket has just become opened.

Parameters

[in]	sock	New socket descriptor.
[in,out]	report	Where to report error.

Reimplemented from ts::Socket.

◆ isOpen()

bool ts::Socket::isOpen ( ) const

inlineinherited

Check if socket is open.

Returns: True if socket is open.

◆ setSendBufferSize()

bool ts::Socket::setSendBufferSize	(	size_t	size,
		Report &	report = `(ts::CerrReport::Instance())`
	)

inherited

Set the send buffer size.

Parameters

[in]	size	Send buffer size in bytes.
[in,out]	report	Where to report error.

Returns: True on success, false on error.

◆ setReceiveBufferSize()

bool ts::Socket::setReceiveBufferSize	(	size_t	size,
		Report &	report = `(ts::CerrReport::Instance())`
	)

inherited

Set the receive buffer size.

Parameters

[in]	size	Receive buffer size in bytes.
[in,out]	report	Where to report error.

Returns: True on success, false on error.

◆ setReceiveTimeout()

bool ts::Socket::setReceiveTimeout	(	cn::milliseconds	timeout,
		Report &	report = `(ts::CerrReport::Instance())`
	)

inherited

Set the receive timeout.

Parameters

[in]	timeout	Receive timeout in milliseconds. If negative, receive timeout is not used.
[in,out]	report	Where to report error.

Returns: True on success, false on error.

◆ reusePort()

bool ts::Socket::reusePort	(	bool	reuse_port,
		Report &	report = `(ts::CerrReport::Instance())`
	)

inherited

Set the "reuse port" option.

Parameters

[in]	reuse_port	If true, the socket is allowed to reuse a local UDP port which is already bound.
[in,out]	report	Where to report error.

Returns: True on success, false on error.

◆ getLocalAddress()

bool ts::Socket::getLocalAddress	(	IPv4SocketAddress &	addr,
		Report &	report = `(ts::CerrReport::Instance())`
	)

inherited

Get local socket address.

Parameters

[out]	addr	Local socket address of the connection.
[in,out]	report	Where to report error.

Returns: True on success, false on error.

◆ getSocket()

SysSocketType ts::Socket::getSocket ( ) const

inlineinherited

Get the underlying socket device handle (use with care).

This method is reserved for low-level operations and should not be used by normal applications.

Returns: The underlying socket system device handle or file descriptor. Return SYS_SOCKET_INVALID if the socket is not open.

◆ createSocket()

bool ts::Socket::createSocket	(	int	domain,
		int	type,
		int	protocol,
		Report &	report
	)

protectedinherited

Create the socket.

Parameters

[in]	domain	Socket domain: PF_INET
[in]	type	Socket type: SOCK_STREAM, SOCK_DGRAM
[in]	protocol	Socket protocol: IPPROTO_TCP, IPPROTO_UDP
[in,out]	report	Where to report error.

Returns: True on success, false on error.

◆ setMaxSeverity()

void ts::Report::setMaxSeverity ( int level )

inherited

Set maximum severity level.

Messages with higher severities are not reported.

Parameters

[in] level Set report to that level.

◆ raiseMaxSeverity()

void ts::Report::raiseMaxSeverity ( int level )

inherited

Raise maximum severity level.

The severity can only be increased (more verbose, more debug), never decreased.

Parameters

[in] level Set report at least to that level.

◆ maxSeverity()

int ts::Report::maxSeverity ( ) const

inlineinherited

Get maximum severity level.

Returns: Current maximum debug level.

◆ gotErrors()

bool ts::Report::gotErrors ( ) const

inlineinherited

Check if errors (or worse) were reported through this object.

Errors which were reported through delegated reports are ignored.

Returns: True if errors (or worse) were reported through this object.

◆ resetErrors()

void ts::Report::resetErrors ( )

inlineinherited

Reset the error indicator.

See also: gotErrors()

◆ setReportPrefix()

void ts::Report::setReportPrefix ( const UString & prefix )

inlineinherited

Set the prefix to display before each message.

Parameters

[in] prefix The prefix to prepend to all messages.

◆ reportPrefix()

UString ts::Report::reportPrefix ( ) const

inlineinherited

Get the current prefix to display.

Returns: The current prefix to display.

◆ delegateReport()

Report * ts::Report::delegateReport ( Report * report )

inherited

Delegate message logging to another report object.

Parameters

[in] report New report object to which messages are delegated. Use nullptr to remove the delegation and return to normal logging.

Returns: Previous delegate report, return a null pointer if there was no previous delegate.

◆ debug() [1/5]

bool ts::Report::debug ( ) const

inlineinherited

Check if debugging is active.

Returns: True if current reporting level is Debug or higher.

◆ debug() [2/5]

void ts::Report::debug ( const UChar * msg )

inlineinherited

Report a debug message.

Parameters

[in] msg Message line.

◆ debug() [3/5]

void ts::Report::debug ( const UString & msg )

inlineinherited

Report a debug message.

Parameters

[in] msg Message line.

◆ debug() [4/5]

template<class... Args>

void ts::Report::debug	(	const UChar *	fmt,
		Args &&...	args
	)

inlineinherited

Report a debug message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ debug() [5/5]

template<class... Args>

void ts::Report::debug	(	const UString &	fmt,
		Args &&...	args
	)

inlineinherited

Report a debug message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ verbose() [1/5]

bool ts::Report::verbose ( ) const

inlineinherited

Check if verbose reporting is active.

Returns: True if current reporting level is Verbose or higher.

◆ verbose() [2/5]

void ts::Report::verbose ( const UChar * msg )

inlineinherited

Report a verbose message.

Parameters

[in] msg Message line.

◆ verbose() [3/5]

void ts::Report::verbose ( const UString & msg )

inlineinherited

Report a verbose message.

Parameters

[in] msg Message line.

◆ verbose() [4/5]

template<class... Args>

void ts::Report::verbose	(	const UChar *	fmt,
		Args &&...	args
	)

inlineinherited

Report a verbose message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ verbose() [5/5]

template<class... Args>

void ts::Report::verbose	(	const UString &	fmt,
		Args &&...	args
	)

inlineinherited

Report a verbose message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ log() [1/3]

void ts::Report::log	(	int	severity,
		const UString &	msg
	)

inherited

Report a message with an explicit severity.

Parameters

[in]	severity	Message severity.
[in]	msg	Message line.

◆ log() [2/3]

template<class... Args>

void ts::Report::log	(	int	severity,
		const UChar *	fmt,
		Args &&...	args
	)

inlineinherited

Report a message with an explicit severity and a printf-like interface.

Parameters

[in]	severity	Message severity.
[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ log() [3/3]

template<class... Args>

void ts::Report::log	(	int	severity,
		const UString &	fmt,
		Args &&...	args
	)

inlineinherited

Report a message with an explicit severity and a printf-like interface.

Parameters

[in]	severity	Message severity.
[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ fatal() [1/4]

void ts::Report::fatal ( const UChar * msg )

inlineinherited

Report a fatal error message.

Parameters

[in] msg Message line.

◆ fatal() [2/4]

void ts::Report::fatal ( const UString & msg )

inlineinherited

Report a fatal error message.

Parameters

[in] msg Message line.

◆ fatal() [3/4]

template<class... Args>

void ts::Report::fatal	(	const UChar *	fmt,
		Args &&...	args
	)

inlineinherited

Report a fatal error message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ fatal() [4/4]

template<class... Args>

void ts::Report::fatal	(	const UString &	fmt,
		Args &&...	args
	)

inlineinherited

Report a fatal error message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ severe() [1/4]

void ts::Report::severe ( const UChar * msg )

inlineinherited

Report a severe error message.

Parameters

[in] msg Message line.

◆ severe() [2/4]

void ts::Report::severe ( const UString & msg )

inlineinherited

Report a severe error message.

Parameters

[in] msg Message line.

◆ severe() [3/4]

template<class... Args>

void ts::Report::severe	(	const UChar *	fmt,
		Args &&...	args
	)

inlineinherited

Report a severe error message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ severe() [4/4]

template<class... Args>

void ts::Report::severe	(	const UString &	fmt,
		Args &&...	args
	)

inlineinherited

Report a severe error message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ error() [1/4]

void ts::Report::error ( const UChar * msg )

inlineinherited

Report an error message.

Parameters

[in] msg Message line.

◆ error() [2/4]

void ts::Report::error ( const UString & msg )

inlineinherited

Report an error message.

Parameters

[in] msg Message line.

◆ error() [3/4]

template<class... Args>

void ts::Report::error	(	const UChar *	fmt,
		Args &&...	args
	)

inlineinherited

Report an error message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ error() [4/4]

template<class... Args>

void ts::Report::error	(	const UString &	fmt,
		Args &&...	args
	)

inlineinherited

Report an error message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ warning() [1/4]

void ts::Report::warning ( const UChar * msg )

inlineinherited

Report a warning error message.

Parameters

[in] msg Message line.

◆ warning() [2/4]

void ts::Report::warning ( const UString & msg )

inlineinherited

Report a warning error message.

Parameters

[in] msg Message line.

◆ warning() [3/4]

template<class... Args>

void ts::Report::warning	(	const UChar *	fmt,
		Args &&...	args
	)

inlineinherited

Report a warning message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ warning() [4/4]

template<class... Args>

void ts::Report::warning	(	const UString &	fmt,
		Args &&...	args
	)

inlineinherited

Report a warning message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ info() [1/4]

void ts::Report::info ( const UChar * msg )

inlineinherited

Report an informational message.

Parameters

[in] msg Message line.

◆ info() [2/4]

void ts::Report::info ( const UString & msg )

inlineinherited

Report an informational message.

Parameters

[in] msg Message line.

◆ info() [3/4]

template<class... Args>

void ts::Report::info	(	const UChar *	fmt,
		Args &&...	args
	)

inlineinherited

Report an informational message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

◆ info() [4/4]

template<class... Args>

void ts::Report::info	(	const UString &	fmt,
		Args &&...	args
	)

inlineinherited

Report an informational message with a printf-like interface.

Parameters

[in]	fmt	Format string with embedded '%' sequences.
[in]	args	List of arguments to substitute in the format string.

See also: UString::format()

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

tsTelnetConnection.h

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TelnetConnection()

Member Function Documentation

◆ send() [1/3]

◆ send() [2/3]

◆ sendLine() [1/2]

◆ sendLine() [2/2]

◆ receive() [1/4]

◆ receive() [2/4]

◆ receiveLine() [1/2]

◆ receiveLine() [2/2]

◆ waitForPrompt()

◆ writeLog()

◆ connect()

◆ isConnected()

◆ getPeer()

◆ peerName()

◆ closeWriter()

◆ disconnect()

◆ send() [3/3]

◆ receive() [3/4]

◆ receive() [4/4]

◆ handleConnected()

◆ handleDisconnected()

◆ handleClosed()

◆ setTTL()

◆ setNoLinger()

◆ setLingerTime()

◆ setKeepAlive()

◆ setNoDelay()

◆ bind()

◆ open()

◆ close()

◆ handleOpened()

◆ declareOpened()

◆ isOpen()

◆ setSendBufferSize()

◆ setReceiveBufferSize()

◆ setReceiveTimeout()

◆ reusePort()

◆ getLocalAddress()

◆ getSocket()

◆ createSocket()

◆ setMaxSeverity()

◆ raiseMaxSeverity()

◆ maxSeverity()

◆ gotErrors()

◆ resetErrors()

◆ setReportPrefix()

◆ reportPrefix()

◆ delegateReport()

◆ debug() [1/5]

◆ debug() [2/5]

◆ debug() [3/5]

◆ debug() [4/5]

◆ debug() [5/5]

◆ verbose() [1/5]

◆ verbose() [2/5]

◆ verbose() [3/5]

◆ verbose() [4/5]

◆ verbose() [5/5]

◆ log() [1/3]

◆ log() [2/3]

◆ log() [3/3]

◆ fatal() [1/4]

◆ fatal() [2/4]

◆ fatal() [3/4]

◆ fatal() [4/4]

◆ severe() [1/4]

◆ severe() [2/4]

◆ severe() [3/4]

◆ severe() [4/4]

◆ error() [1/4]

◆ error() [2/4]