#include <telnet.h>
Inheritance diagram for PTelnetSocket:
Public Types | |
| IAC = 255 | |
| Interpret As Command - escape character. | |
| DONT = 254 | |
| You are not to use option. | |
| DO = 253 | |
| Request to use option. | |
| WONT = 252 | |
| Refuse use of option. | |
| WILL = 251 | |
| Accept the use of option. | |
| SB = 250 | |
| Subnegotiation begin. | |
| GoAhead = 249 | |
| Function GA, you may reverse the line. | |
| EraseLine = 248 | |
| Function EL, erase the current line. | |
| EraseChar = 247 | |
| Function EC, erase the current character. | |
| AreYouThere = 246 | |
| Function AYT, are you there? | |
| AbortOutput = 245 | |
| Function AO, abort output stream. | |
| InterruptProcess = 244 | |
| Function IP, interrupt process, permanently. | |
| Break = 243 | |
| NVT character break. | |
| DataMark = 242 | |
| Marker for connection cleaning. | |
| NOP = 241 | |
| No operation. | |
| SE = 240 | |
| Subnegotiation end. | |
| EndOfReccord = 239 | |
| End of record for transparent mode. | |
| AbortProcess = 238 | |
| Abort the entire process. | |
| SuspendProcess = 237 | |
| Suspend the process. | |
| EndOfFile = 236 | |
| End of file marker. | |
| TransmitBinary = 0 | |
| Assume binary 8 bit data is transferred. | |
| EchoOption = 1 | |
| Automatically echo characters sent. | |
| ReconnectOption = 2 | |
| Prepare to reconnect. | |
| SuppressGoAhead = 3 | |
| Do not use the GA protocol. | |
| MessageSizeOption = 4 | |
| Negatiate approximate message size. | |
| StatusOption = 5 | |
| Status packets are understood. | |
| TimingMark = 6 | |
| Marker for synchronisation. | |
| RCTEOption = 7 | |
| Remote controlled transmission and echo. | |
| OutputLineWidth = 8 | |
| Negotiate about output line width. | |
| OutputPageSize = 9 | |
| Negotiate about output page size. | |
| CRDisposition = 10 | |
| Negotiate about CR disposition. | |
| HorizontalTabsStops = 11 | |
| Negotiate about horizontal tabstops. | |
| HorizTabDisposition = 12 | |
| Negotiate about horizontal tab disposition. | |
| FormFeedDisposition = 13 | |
| Negotiate about formfeed disposition. | |
| VerticalTabStops = 14 | |
| Negotiate about vertical tab stops. | |
| VertTabDisposition = 15 | |
| Negotiate about vertical tab disposition. | |
| LineFeedDisposition = 16 | |
| Negotiate about output LF disposition. | |
| ExtendedASCII = 17 | |
| Extended ascic character set. | |
| ForceLogout = 18 | |
| Force logout. | |
| ByteMacroOption = 19 | |
| Byte macro. | |
| DataEntryTerminal = 20 | |
| data entry terminal. | |
| SupDupProtocol = 21 | |
| supdup protocol. | |
| SupDupOutput = 22 | |
| supdup output. | |
| SendLocation = 23 | |
| Send location. | |
| TerminalType = 24 | |
| Provide terminal type information. | |
| EndOfRecordOption = 25 | |
| Record boundary marker. | |
| TACACSUID = 26 | |
| TACACS user identification. | |
| OutputMark = 27 | |
| Output marker or banner text. | |
| TerminalLocation = 28 | |
| Terminals physical location information. | |
| Use3270RegimeOption = 29 | |
| 3270 regime. | |
| UseX3PADOption = 30 | |
| X.3 PAD. | |
| WindowSize = 31 | |
| NAWS - Negotiate About Window Size. | |
| TerminalSpeed = 32 | |
| Provide terminal speed information. | |
| FlowControl = 33 | |
| Remote flow control. | |
| LineModeOption = 34 | |
| Terminal in line mode option. | |
| XDisplayLocation = 35 | |
| X Display location. | |
| EnvironmentOption = 36 | |
| Provide environment information. | |
| AuthenticateOption = 37 | |
| Authenticate option. | |
| EncriptionOption = 38 | |
| Encryption option. | |
| EncryptionOption = 38 | |
| Duplicate to fix spelling mistake and remain backwards compatible. | |
| ExtendedOptionsList = 255 | |
| Code for extended options. | |
| MaxOptions | |
| SubOptionIs = 0 | |
| Sub-option is... | |
| SubOptionSend = 1 | |
| Request to send option. | |
| 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) | |
| PBoolean | Read (void *buf, PINDEX len) |
| PBoolean | Write (const void *buf, PINDEX len) |
| virtual PBoolean | Connect (const PString &address) |
| virtual PBoolean | Accept (PSocket &socket) |
| virtual void | OnOutOfBand (const void *buf, PINDEX len) |
| PBoolean | SendCommand (Command cmd, int opt=0) |
| virtual PBoolean | SendDo (BYTE option) |
| virtual PBoolean | SendDont (BYTE option) |
| virtual PBoolean | SendWill (BYTE option) |
| virtual PBoolean | SendWont (BYTE option) |
| PBoolean | SendSubOption (BYTE code, const BYTE *info, PINDEX len, int subCode=-1) |
| void | SetOurOption (BYTE code, PBoolean state=PTrue) |
| void | SetTheirOption (BYTE code, PBoolean state=PTrue) |
| PBoolean | IsOurOption (BYTE code) const |
| PBoolean | 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 PBoolean | OnCommand (BYTE code) |
Protected Attributes | |
| OptionInfo | option [MaxOptions] |
| PString | terminalType |
| WORD | windowWidth |
| WORD | windowHeight |
| PBoolean | debug |
Classes | |
| struct | OptionInfo |
| PTelnetSocket::PTelnetSocket | ( | ) |
| PTelnetSocket::PTelnetSocket | ( | const PString & | address | ) |
| address | Address of remote machine to connect to. |
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.
| socket | Listening socket making the connection. |
Reimplemented from PTCPSocket.
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.
| address | Address of remote machine to connect to. |
Reimplemented from PIPSocket.
| void PTelnetSocket::Construct | ( | ) | [protected] |
Reimplemented from PChannel.
| const PString& PTelnetSocket::GetTerminalType | ( | ) | const [inline] |
| void PTelnetSocket::GetWindowSize | ( | WORD & | width, | |
| WORD & | height | |||
| ) | const |
| width | Old window width. |
| height | Old window height. |
| PBoolean PTelnetSocket::IsOurOption | ( | BYTE | code | ) | const [inline] |
Determine if the option on our side is enabled.
| code | Option to check. |
| PBoolean PTelnetSocket::IsTheirOption | ( | BYTE | code | ) | const [inline] |
Determine if the option on their side is enabled.
| code | Option to check. |
| virtual PBoolean 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 PTrue) and returns PTrue;
| code | Code received that could not be precessed. |
| 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.
| 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.
| option | Option to DONT |
| 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.
| buf | Data to be received as URGENT TCP data. |
| len |
Number of bytes pointed to by buf. |
Reimplemented from PTCPSocket.
| 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.
| code | Option code for sub-option data. |
| info | Extra information being sent in the sub-option. |
| len | Number of extra bytes. |
| 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.
| 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.
| option | Option to WONT |
| PBoolean 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 PFalse to determine what caused the failure.
The TELNET channel intercepts and escapes commands in the data stream to implement the TELNET protocol.
| 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.
Send an escaped IAC command. The opt parameters meaning depends on the command being sent:
opt is Options code.
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.
| cmd | Command code to send |
| opt | Option for command code. |
| virtual PBoolean PTelnetSocket::SendDo | ( | BYTE | option | ) | [virtual] |
Send DO request.
| option | Option to DO |
| virtual PBoolean PTelnetSocket::SendDont | ( | BYTE | option | ) | [virtual] |
Send DONT command.
| option | Option to DONT |
| PBoolean PTelnetSocket::SendSubOption | ( | BYTE | code, | |
| const BYTE * | info, | |||
| PINDEX | len, | |||
| int | subCode = -1 | |||
| ) |
Send a sub-option with the information given.
| code | Suboptions option code. |
| info | Information to send. |
| len | Length of information. |
| subCode | Suboptions sub-code, -1 indicates no sub-code. |
| virtual PBoolean PTelnetSocket::SendWill | ( | BYTE | option | ) | [virtual] |
Send WILL request.
| option | Option to WILL |
| virtual PBoolean PTelnetSocket::SendWont | ( | BYTE | option | ) | [virtual] |
Send WONT command.
| option | Option to WONT |
| void PTelnetSocket::SetOurOption | ( | BYTE | code, | |
| PBoolean | state = PTrue | |||
| ) | [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.
| code | Option to check. |
| state | New state for for option. |
| void PTelnetSocket::SetTerminalType | ( | const PString & | newType | ) |
| newType | New terminal type description string. |
| void PTelnetSocket::SetTheirOption | ( | BYTE | code, | |
| PBoolean | state = PTrue | |||
| ) | [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.
| code | Option to check. |
| state | New state for for option. |
| void PTelnetSocket::SetWindowSize | ( | WORD | width, | |
| WORD | height | |||
| ) |
| width | New window width. |
| height | New window height. |
| PBoolean 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 PFalse to determine what caused the failure.
The TELNET channel intercepts and escapes commands in the data stream to implement the TELNET protocol.
Returns PTrue if at least len bytes were written to the channel.
| buf | Pointer to a block of memory to write. |
| len | Number of bytes to write. |
Reimplemented from PTCPSocket.
PBoolean PTelnetSocket::debug [protected] |
OptionInfo PTelnetSocket::option[MaxOptions] [protected] |
PString PTelnetSocket::terminalType [protected] |
WORD PTelnetSocket::windowHeight [protected] |
WORD PTelnetSocket::windowWidth [protected] |
1.4.7