#include <telnet.h>
Inheritance diagram for PTelnetSocket:
| PTelnetSocket::PTelnetSocket | ( | ) |
| PTelnetSocket::PTelnetSocket | ( | const PString & | address | ) |
| address | Address of remote machine to connect to. |
| 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.
| 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.
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.
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.
| 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.
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 |
| 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 |
| 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. |
| 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::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. |
| 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. |
| void PTelnetSocket::SetTerminalType | ( | const PString & | newType | ) |
| newType | New terminal type description string. |
| const PString& PTelnetSocket::GetTerminalType | ( | ) | const [inline] |
| void PTelnetSocket::SetWindowSize | ( | WORD | width, | |
| WORD | height | |||
| ) |
| width | New window width. |
| height | New window height. |
| void PTelnetSocket::GetWindowSize | ( | WORD & | width, | |
| WORD & | height | |||
| ) | const |
| 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.
| 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::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 |
| 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 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. |
OptionInfo PTelnetSocket::option[MaxOptions] [protected] |
PString PTelnetSocket::terminalType [protected] |
WORD PTelnetSocket::windowWidth [protected] |
WORD PTelnetSocket::windowHeight [protected] |
PBoolean PTelnetSocket::debug [protected] |
1.5.1