PTLib: PTelnetSocket Class Reference

Enumerator:

IAC	Interpret As Command - escape character.
DONT	You are not to use option.
DO	Request to use option.
WONT	Refuse use of option.
WILL	Accept the use of option.
SB	Subnegotiation begin.
GoAhead	Function GA, you may reverse the line.
EraseLine	Function EL, erase the current line.
EraseChar	Function EC, erase the current character.
AreYouThere	Function AYT, are you there?
AbortOutput	Function AO, abort output stream.
InterruptProcess	Function IP, interrupt process, permanently.
Break	NVT character break.
DataMark	Marker for connection cleaning.
NOP	No operation.
SE	Subnegotiation end.
EndOfReccord	End of record for transparent mode.
AbortProcess	Abort the entire process.
SuspendProcess	Suspend the process.
EndOfFile	End of file marker.

enum PTelnetSocket::Options

Enumerator:

TransmitBinary	Assume binary 8 bit data is transferred.
EchoOption	Automatically echo characters sent.
ReconnectOption	Prepare to reconnect.
SuppressGoAhead	Do not use the GA protocol.
MessageSizeOption	Negatiate approximate message size.
StatusOption	Status packets are understood.
TimingMark	Marker for synchronisation.
RCTEOption	Remote controlled transmission and echo.
OutputLineWidth	Negotiate about output line width.
OutputPageSize	Negotiate about output page size.
CRDisposition	Negotiate about CR disposition.
HorizontalTabsStops	Negotiate about horizontal tabstops.
HorizTabDisposition	Negotiate about horizontal tab disposition.
FormFeedDisposition	Negotiate about formfeed disposition.
VerticalTabStops	Negotiate about vertical tab stops.
VertTabDisposition	Negotiate about vertical tab disposition.
LineFeedDisposition	Negotiate about output LF disposition.
ExtendedASCII	Extended ascic character set.
ForceLogout	Force logout.
ByteMacroOption	Byte macro.
DataEntryTerminal	data entry terminal.
SupDupProtocol	supdup protocol.
SupDupOutput	supdup output.
SendLocation	Send location.
TerminalType	Provide terminal type information.
EndOfRecordOption	Record boundary marker.
TACACSUID	TACACS user identification.
OutputMark	Output marker or banner text.
TerminalLocation	Terminals physical location information.
Use3270RegimeOption	3270 regime.
UseX3PADOption	X.3 PAD.
WindowSize	NAWS - Negotiate About Window Size.
TerminalSpeed	Provide terminal speed information.
FlowControl	Remote flow control.
LineModeOption	Terminal in line mode option.
XDisplayLocation	X Display location.
EnvironmentOption	Provide environment information.
AuthenticateOption	Authenticate option.
EncriptionOption	Encryption option.
EncryptionOption	Duplicate to fix spelling mistake and remain backwards compatible.
ExtendedOptionsList	Code for extended options.
MaxOptions

enum PTelnetSocket::SubOptionCodes

Enumerator:

SubOptionIs	Sub-option is...
SubOptionSend	Request to send option.

PTelnetSocket::PTelnetSocket ( )

PTelnetSocket::PTelnetSocket ( const PString & address )

Parameters:

address

Address of remote machine to connect to.

BOOL PTelnetSocket::Read	(	void *	buf,
		PINDEX	len
	)			`[virtual]`

Low level read from the channel. This function may block until the requested number of characters were read or the read timeout was reached. The GetLastReadCount() function returns the actual number of bytes read.

The GetErrorCode() function should be consulted after Read() returns FALSE to determine what caused the failure.

The TELNET channel intercepts and escapes commands in the data stream to implement the TELNET protocol.

Returns:: TRUE indicates that at least one character was read from the channel. FALSE means no bytes were read due to timeout or some other I/O error.

Parameters:

buf	Pointer to a block of memory to receive the read bytes.
len	Maximum number of bytes to read into the buffer.

Reimplemented from PTCPSocket.

BOOL PTelnetSocket::Write	(	const void *	buf,
		PINDEX	len
	)			`[virtual]`

Low level write to the channel. This function will block until the requested number of characters are written or the write timeout is reached. The GetLastWriteCount() function returns the actual number of bytes written.

The GetErrorCode() function should be consulted after Write() returns FALSE to determine what caused the failure.

The TELNET channel intercepts and escapes commands in the data stream to implement the TELNET protocol.

Returns TRUE if at least len bytes were written to the channel.

Parameters:

buf	Pointer to a block of memory to write.
len	Number of bytes to write.

Reimplemented from PTCPSocket.

virtual BOOL PTelnetSocket::Connect ( const PString & address ) [virtual]

Connect a socket to a remote host on the specified port number. This is typically used by the client or initiator of a communications channel. This connects to a "listening" socket at the other end of the communications channel.

The port number as defined by the object instance construction or the PIPSocket::SetPort() function.

Returns:: TRUE if the channel was successfully connected to the remote host.

Parameters:

address

Address of remote machine to connect to.

Reimplemented from PIPSocket.

virtual BOOL PTelnetSocket::Accept ( PSocket & socket ) [virtual]

Open a socket to a remote host on the specified port number. This is an "accepting" socket. When a "listening" socket has a pending connection to make, this will accept a connection made by the "connecting" socket created to establish a link.

The port that the socket uses is the one used in the Listen() command of the socket parameter.

Note that this function will block until a remote system connects to the port number specified in the "listening" socket.

Returns:: TRUE if the channel was successfully opened.

Parameters:

socket

Listening socket making the connection.

Reimplemented from PTCPSocket.

virtual void PTelnetSocket::OnOutOfBand	(	const void *	buf,
		PINDEX	len
	)			`[virtual]`

This is callback function called by the system whenever out of band data from the TCP/IP stream is received. A descendent class may interpret this data according to the semantics of the high level protocol.

The TELNET socket uses this for sychronisation.

Parameters:

buf	Data to be received as URGENT TCP data.
len	Number of bytes pointed to by `buf`.

Reimplemented from PTCPSocket.

BOOL PTelnetSocket::SendCommand	(	Command	cmd,
		int	opt = `0`
	)

Send an escaped IAC command. The opt parameters meaning depends on the command being sent:

DO, DONT, WILL, WONT: opt is Options code.
AbortOutput: TRUE is flush buffer.
InterruptProcess, Break, AbortProcess, SuspendProcess: TRUE is synchronise.

Synchronises the TELNET streams, inserts the data mark into outgoing data stream and sends an out of band data to the remote to flush all data in the stream up until the syncronisation command.

Returns:: TRUE if the command was successfully sent.

Parameters:

cmd	Command code to send
opt	Option for command code.

virtual BOOL PTelnetSocket::SendDo ( BYTE option ) [virtual]

Send DO request.

Returns:: TRUE if the command was successfully sent.

Parameters:

option

Option to DO

virtual BOOL PTelnetSocket::SendDont ( BYTE option ) [virtual]

Send DONT command.

Returns:: TRUE if the command was successfully sent.

Parameters:

option

Option to DONT

virtual BOOL PTelnetSocket::SendWill ( BYTE option ) [virtual]

Send WILL request.

Returns:: TRUE if the command was successfully sent.

Parameters:

option

Option to WILL

virtual BOOL PTelnetSocket::SendWont ( BYTE option ) [virtual]

Send WONT command.

Returns:: TRUE if the command was successfully sent.

Parameters:

option

Option to WONT

BOOL PTelnetSocket::SendSubOption	(	BYTE	code,
		const BYTE *	info,
		PINDEX	len,
		int	subCode = `-1`
	)

Send a sub-option with the information given.

Returns:: TRUE if the command was successfully sent.

Parameters:

code	Suboptions option code.
info	Information to send.
len	Length of information.
subCode	Suboptions sub-code, -1 indicates no sub-code.

void PTelnetSocket::SetOurOption	(	BYTE	code,
		BOOL	state = `TRUE`
	)			`[inline]`

Set if the option on our side is possible, this does not mean it is set it only means that in response to a DO we WILL rather than WONT.

Parameters:

code	Option to check.
state	New state for for option.

void PTelnetSocket::SetTheirOption	(	BYTE	code,
		BOOL	state = `TRUE`
	)			`[inline]`

Set if the option on their side is desired, this does not mean it is set it only means that in response to a WILL we DO rather than DONT.

Parameters:

code	Option to check.
state	New state for for option.

BOOL PTelnetSocket::IsOurOption ( BYTE code ) const [inline]

Determine if the option on our side is enabled.

Returns:: TRUE if option is enabled.

Parameters:

code

Option to check.

BOOL PTelnetSocket::IsTheirOption ( BYTE code ) const [inline]

Determine if the option on their side is enabled.

Returns:: TRUE if option is enabled.

Parameters:

code

Option to check.

void PTelnetSocket::SetTerminalType ( const PString & newType )

Parameters:

newType

New terminal type description string.

const PString& PTelnetSocket::GetTerminalType ( ) const [inline]

void PTelnetSocket::SetWindowSize	(	WORD	width,
		WORD	height
	)

Parameters:

width	New window width.
height	New window height.

void PTelnetSocket::GetWindowSize	(	WORD &	width,
		WORD &	height
	)			const

Parameters:

width	Old window width.
height	Old window height.

void PTelnetSocket::Construct ( ) [protected]

Reimplemented from PChannel.

virtual void PTelnetSocket::OnDo ( BYTE option ) [protected, virtual]

This callback function is called by the system when it receives a DO request from the remote system.

The default action is to send a WILL for options that are understood by the standard TELNET class and a WONT for all others.

Returns:: TRUE if option is accepted.

Parameters:

option

Option to DO

virtual void PTelnetSocket::OnDont ( BYTE option ) [protected, virtual]

This callback function is called by the system when it receives a DONT request from the remote system.

The default action is to disable options that are understood by the standard TELNET class. All others are ignored.

Parameters:

option

Option to DONT

virtual void PTelnetSocket::OnWill ( BYTE option ) [protected, virtual]

This callback function is called by the system when it receives a WILL request from the remote system.

The default action is to send a DO for options that are understood by the standard TELNET class and a DONT for all others.

Parameters:

option

Option to WILL

virtual void PTelnetSocket::OnWont ( BYTE option ) [protected, virtual]

This callback function is called by the system when it receives a WONT request from the remote system.

The default action is to disable options that are understood by the standard TELNET class. All others are ignored.

Parameters:

option

Option to WONT

virtual void PTelnetSocket::OnSubOption	(	BYTE	code,
		const BYTE *	info,
		PINDEX	len
	)			`[protected, virtual]`

This callback function is called by the system when it receives a sub-option command from the remote system.

Parameters:

code	Option code for sub-option data.
info	Extra information being sent in the sub-option.
len	Number of extra bytes.

virtual BOOL PTelnetSocket::OnCommand ( BYTE code ) [protected, virtual]

This callback function is called by the system when it receives an telnet command that it does not do anything with.

The default action displays a message to the PError stream (when debug is TRUE) and returns TRUE;

Returns:: TRUE if next byte is not part of the command.

Parameters:

code

Code received that could not be precessed.

OptionInfo PTelnetSocket::option[MaxOptions] [protected]

PString PTelnetSocket::terminalType [protected]

WORD PTelnetSocket::windowWidth [protected]

WORD PTelnetSocket::windowHeight [protected]

BOOL PTelnetSocket::debug [protected]

PTelnetSocket Class Reference

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Classes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation


Public Types
enum	Command { IAC = 255, DONT = 254, DO = 253, WONT = 252, WILL = 251, SB = 250, GoAhead = 249, EraseLine = 248, EraseChar = 247, AreYouThere = 246, AbortOutput = 245, InterruptProcess = 244, Break = 243, DataMark = 242, NOP = 241, SE = 240, EndOfReccord = 239, AbortProcess = 238, SuspendProcess = 237, EndOfFile = 236 }
enum	Options { TransmitBinary = 0, EchoOption = 1, ReconnectOption = 2, SuppressGoAhead = 3, MessageSizeOption = 4, StatusOption = 5, TimingMark = 6, RCTEOption = 7, OutputLineWidth = 8, OutputPageSize = 9, CRDisposition = 10, HorizontalTabsStops = 11, HorizTabDisposition = 12, FormFeedDisposition = 13, VerticalTabStops = 14, VertTabDisposition = 15, LineFeedDisposition = 16, ExtendedASCII = 17, ForceLogout = 18, ByteMacroOption = 19, DataEntryTerminal = 20, SupDupProtocol = 21, SupDupOutput = 22, SendLocation = 23, TerminalType = 24, EndOfRecordOption = 25, TACACSUID = 26, OutputMark = 27, TerminalLocation = 28, Use3270RegimeOption = 29, UseX3PADOption = 30, WindowSize = 31, TerminalSpeed = 32, FlowControl = 33, LineModeOption = 34, XDisplayLocation = 35, EnvironmentOption = 36, AuthenticateOption = 37, EncriptionOption = 38, EncryptionOption = 38, ExtendedOptionsList = 255, MaxOptions }
enum	SubOptionCodes { SubOptionIs = 0, SubOptionSend = 1 }
Public Member Functions
	PTelnetSocket ()
	PTelnetSocket (const PString &address)
BOOL	Read (void *buf, PINDEX len)
BOOL	Write (const void *buf, PINDEX len)
virtual BOOL	Connect (const PString &address)
virtual BOOL	Accept (PSocket &socket)
virtual void	OnOutOfBand (const void *buf, PINDEX len)
BOOL	SendCommand (Command cmd, int opt=0)
virtual BOOL	SendDo (BYTE option)
virtual BOOL	SendDont (BYTE option)
virtual BOOL	SendWill (BYTE option)
virtual BOOL	SendWont (BYTE option)
BOOL	SendSubOption (BYTE code, const BYTE *info, PINDEX len, int subCode=-1)
void	SetOurOption (BYTE code, BOOL state=TRUE)
void	SetTheirOption (BYTE code, BOOL state=TRUE)
BOOL	IsOurOption (BYTE code) const
BOOL	IsTheirOption (BYTE code) const
void	SetTerminalType (const PString &newType)
const PString &	GetTerminalType () const
void	SetWindowSize (WORD width, WORD height)
void	GetWindowSize (WORD &width, WORD &height) const
Protected Member Functions
void	Construct ()
virtual void	OnDo (BYTE option)
virtual void	OnDont (BYTE option)
virtual void	OnWill (BYTE option)
virtual void	OnWont (BYTE option)
virtual void	OnSubOption (BYTE code, const BYTE *info, PINDEX len)
virtual BOOL	OnCommand (BYTE code)
Protected Attributes
OptionInfo	option [MaxOptions]
PString	terminalType
WORD	windowWidth
WORD	windowHeight
BOOL	debug
Classes
struct	OptionInfo