intro(3TELD)

NAME | SYNOPSIS | DESCRIPTION | API | ATTRIBUTES |

NAME

Intro- introduction to the TELNETD library

SYNOPSIS

#include <arpa/telnetd.h>

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 using the TELNET protocol or by the TELNET server using 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

Name

Description

inetAccept(3TELD)

wait for a new INET connection

inetBind(3TELD)

bind, close INET sockets

inetClient(3TELD)

See inetAccept(3TELD)

inetClose(3TELD)

See inetBind(3TELD)

telnetdFlush(3TELD)

See telnetdWrite(3TELD)

telnetdFree(3TELD)

See telnetdInit(3TELD)

telnetdGetTermState(3TELD)

get or set TELNET terminal state

telnetdInit(3TELD)

initialize or free a TELNET session

telnetdPasswd(3TELD)

See telnetdUser(3TELD)

telnetdRead(3TELD)

read from a TELNET session

telnetdReadLine(3TELD)

read a line of characters from a TELNET session

telnetdSetTermState(3TELD)

See telnetdGetTermState(3TELD)

telnetdUser(3TELD)

TELNET session authentication

telnetdWrite(3TELD)

write or flush a TELNET session

ChorusOS 4.0  Last Revised December 1999

NAME | SYNOPSIS | DESCRIPTION | API | ATTRIBUTES |