intro(3TELD)

NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | API | ATTRIBUTES

NAME

Intro- Introduction to the TELNETD library

SYNOPSIS

#include <arpa/telnetd.h>

API RESTRICTIONS

The function or functions documented here may not be used safely in all application contexts with all APIs provided in the ChorusOS 5.0 product.

See API(5FEA) for details.

DESCRIPTION

The TELNETD library provides a set of functions to control and access the server side of a TELNET session. The library functions manage the TELNET protocol, filtering all TELNET commands from the stream of characters sent by the TELNET client.

For each active TELNET session, the library maintains the state associated to the virtual terminal. This state can be modified either by the TELNET client through the TELNET protocol, or by the TELNET server through the telnetdSetTermState() function of the TELNETD library. The telnetdSetTermState() function can be used to switch the input mode of the TELNET client from line mode to one character at a time mode.

API

The TELNETD library API is summarized in the following table.

Function	Comment
inetAccept	Accept new connections
inetBind	Create and bind sockets to IP ports
inetClient	Get the client IP address
inetClose	Close sockets created by inetBind()
telnetdFlush	Write out buffered data of a TELNET session
telnetdFree	Free resources associated to a TELNET session
telnetdGetTermState	Get the terminal state of a TELNET session
telnetdInit	Initialize a TELNET session on a new connection
telnetdPasswd	Get the password of the user of a TELNET session
telnetdRead	Read characters from a TELNET session
telnetdReadLine	Read a line of characters from a TELNET session
telnetdSetTermState	Set the terminal state of a TELNET session
telnetdUser	Get the name of the user of a TELNET session
telnetdWrite	Write characters on a TELNET session

As these functions rely on the POSIX socket API, their use should be restricted to a ChorusOS system configured with the enabled POSIX_SOCKETS feature.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Evolving

ChorusOS 5.0  Last Revised December 2001

NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | API | ATTRIBUTES