#include <inetprot.h>
Inheritance diagram for PInternetProtocol:
Public Member Functions | |
| virtual PBoolean | Read (void *buf, PINDEX len) |
| virtual PBoolean | Write (const void *buf, PINDEX len) |
| void | SetReadLineTimeout (const PTimeInterval &t) |
| virtual PBoolean | Connect (const PString &address, WORD port=0) |
| virtual PBoolean | Connect (const PString &address, const PString &service) |
| virtual PBoolean | Accept (PSocket &listener) |
| const PString & | GetDefaultService () const |
| PIPSocket * | GetSocket () const |
| virtual PBoolean | WriteLine (const PString &line) |
| virtual PBoolean | ReadLine (PString &line, PBoolean allowContinuation=PFalse) |
| virtual void | UnRead (int ch) |
| virtual void | UnRead (const PString &str) |
| virtual void | UnRead (const void *buffer, PINDEX len) |
| virtual PBoolean | WriteCommand (PINDEX cmdNumber) |
| virtual PBoolean | WriteCommand (PINDEX cmdNumber, const PString ¶m) |
| virtual PBoolean | ReadCommand (PINDEX &num, PString &args) |
| virtual PBoolean | WriteResponse (unsigned numericCode, const PString &info) |
| virtual PBoolean | WriteResponse (const PString &code, const PString &info) |
| virtual PBoolean | ReadResponse () |
| virtual PBoolean | ReadResponse (int &code, PString &info) |
| virtual int | ExecuteCommand (PINDEX cmdNumber) |
| virtual int | ExecuteCommand (PINDEX cmdNumber, const PString ¶m) |
| int | GetLastResponseCode () const |
| PString | GetLastResponseInfo () const |
Protected Types | |
| enum | StuffState { DontStuff, StuffIdle, StuffCR, StuffCRLF, StuffCRLFdot, StuffCRLFdotCR } |
Protected Member Functions | |
| PInternetProtocol (const char *defaultServiceName, PINDEX cmdCount, char const *const *cmdNames) | |
| virtual PINDEX | ParseResponse (const PString &line) |
Protected Attributes | |
| PString | defaultServiceName |
| PStringArray | commandNames |
| PCharArray | unReadBuffer |
| PINDEX | unReadCount |
| PTimeInterval | readLineTimeout |
| enum PInternetProtocol::StuffState | stuffingState |
| PBoolean | newLineToCRLF |
| int | lastResponseCode |
| PString | lastResponseInfo |
A command consists of a line starting with a short, case insensitive command string terminated by a space or the end of the line. This may be followed by optional arguments.
A response to a command is usually a number and/or a short string eg "OK". The response may be followed by additional information about the response but this is not typically used by the protocol. It is only for user information and may be tracked in log files etc.
All command and reponse lines of the protocol are terminated by a CR/LF pair. A command or response line may be followed by additional data as determined by the protocol, but this data is "outside" the protocol specification as defined by this class.
The default read timeout is to 10 minutes by the constructor.
enum PInternetProtocol::StuffState [protected] |
| PInternetProtocol::PInternetProtocol | ( | const char * | defaultServiceName, | |
| PINDEX | cmdCount, | |||
| char const *const * | cmdNames | |||
| ) | [protected] |
| defaultServiceName | Service name for the protocol. |
| cmdCount | Number of command strings. |
| cmdNames | Strings for each command. |
| virtual PBoolean PInternetProtocol::Read | ( | void * | buf, | |
| PINDEX | len | |||
| ) | [virtual] |
Low level read from the channel.
This override also supports the mechanism in the UnRead() function allowing characters to be be "put back" into the data stream. This allows a look-ahead required by the logic of some protocols. This is completely independent of the standard iostream mechanisms which do not support the level of timeout control required by the protocols.
| buf | Pointer to a block of memory to receive the read bytes. |
| len | Maximum number of bytes to read into the buffer. |
Reimplemented from PIndirectChannel.
| virtual PBoolean PInternetProtocol::Write | ( | const void * | buf, | |
| PINDEX | len | |||
| ) | [virtual] |
Low level write to the channel.
This override assures that the sequence CR/LF/./CR/LF does not occur by byte stuffing an extra '.' character into the data stream, whenever a line begins with a '.' character.
Note that this only occurs if the member variable stuffingState has been set to some value other than DontStuff, usually StuffIdle. Also, if the newLineToCRLF member variable is PTrue then all occurrences of a '
' character will be translated to a CR/LF pair.
| buf | Pointer to a block of memory to write. |
| len | Number of bytes to write. |
Reimplemented from PIndirectChannel.
| void PInternetProtocol::SetReadLineTimeout | ( | const PTimeInterval & | t | ) |
Set the maximum timeout between characters within a line. Default value is 10 seconds.
Connect a socket to a remote host for the internet protocol.
| address | Address of remote machine to connect to. |
| port | Port number to use for the connection. |
| virtual PBoolean PInternetProtocol::Connect | ( | const PString & | address, | |
| const PString & | service | |||
| ) | [virtual] |
| address | Address of remote machine to connect to. |
| service | Service name to use for the connection. |
Accept a server socket to a remote host for the internet protocol.
| listener | Address of remote machine to connect to. |
| const PString& PInternetProtocol::GetDefaultService | ( | ) | const |
Get the default service name or port number to use in socket connections.
| PIPSocket* PInternetProtocol::GetSocket | ( | ) | const |
Get the eventual socket for the series of indirect channels that may be between the current protocol and the actual I/O channel.
This will assert if the I/O channel is not an IP socket.
Write a string to the socket channel followed by a CR/LF pair. If there are any lone CR or LF characters in the line parameter string, then these are translated into CR/LF pairs.
| line | String to write as a command line. |
| virtual PBoolean PInternetProtocol::ReadLine | ( | PString & | line, | |
| PBoolean | allowContinuation = PFalse | |||
| ) | [virtual] |
Read a string from the socket channel up to a CR/LF pair.
If the unstuffLine parameter is set then the function will remove the '.' character from the start of any line that begins with two consecutive '.' characters. A line that has is exclusively a '.' character will make the function return PFalse.
Note this function will block for the time specified by the PChannel::SetReadTimeout() function for only the first character in the line. The rest of the characters must each arrive within the time set by the readLineTimeout member variable. The timeout is set back to the original setting when the function returns.
| line | String to receive a CR/LF terminated line. |
| allowContinuation | Flag to handle continued lines. |
| virtual void PInternetProtocol::UnRead | ( | int | ch | ) | [virtual] |
Put back the characters into the data stream so that the next Read() function call will return them first.
| ch | Individual character to be returned. |
| virtual void PInternetProtocol::UnRead | ( | const PString & | str | ) | [virtual] |
| str | String to be put back into data stream. |
| virtual void PInternetProtocol::UnRead | ( | const void * | buffer, | |
| PINDEX | len | |||
| ) | [virtual] |
| buffer | Characters to be put back into data stream. |
| len | Number of characters to be returned. |
| virtual PBoolean PInternetProtocol::WriteCommand | ( | PINDEX | cmdNumber | ) | [virtual] |
Write a single line for a command. The command name for the command number is output, then a space, the the param string followed at the end with a CR/LF pair.
If the cmdNumber parameter is outside of the range of valid command names, then the function does not send anything and returns PFalse.
This function is typically used by client forms of the socket.
| cmdNumber | Number of command to write. |
| virtual PBoolean PInternetProtocol::WriteCommand | ( | PINDEX | cmdNumber, | |
| const PString & | param | |||
| ) | [virtual] |
| cmdNumber | Number of command to write. |
| param | Extra parameters required by the command. |
Read a single line of a command which ends with a CR/LF pair. The command number for the command name is parsed from the input, then the remaining text on the line is returned in the args parameter.
If the command does not match any of the command names then the entire line is placed in the args parameter and a value of P_MAX_INDEX is returned.
Note this function will block for the time specified by the PChannel::SetReadTimeout() function.
This function is typically used by server forms of the socket.
| num | Number of the command parsed from the command line, or P_MAX_INDEX if no match. |
| args | String to receive the arguments to the command. |
| virtual PBoolean PInternetProtocol::WriteResponse | ( | unsigned | numericCode, | |
| const PString & | info | |||
| ) | [virtual] |
Write a response code followed by a text string describing the response to a command. The form of the response is to place the code string, then the info string.
If the info parameter has multiple lines then each line has the response code at the start. A '-' character separates the code from the text on all lines but the last where a ' ' character is used.
The first form assumes that the response code is a 3 digit numerical code. The second form allows for any arbitrary string to be the code.
This function is typically used by server forms of the socket.
| numericCode | Response code for command response. |
| info | Extra information available after response code. |
| virtual PBoolean PInternetProtocol::WriteResponse | ( | const PString & | code, | |
| const PString & | info | |||
| ) | [virtual] |
| code | Response code for command response. |
| info | Extra information available after response code. |
| virtual PBoolean PInternetProtocol::ReadResponse | ( | ) | [virtual] |
Read a response code followed by a text string describing the response to a command. The form of the response is to have the code string, then the info string.
The response may have multiple lines in it. A '-' character separates the code from the text on all lines but the last where a ' ' character is used. The info parameter will have placed in it all of the response lines separated by a single '
' character.
The first form places the response code and info into the protected member variables lastResponseCode and lastResponseInfo.
This function is typically used by client forms of the socket.
| code | Response code for command response. |
| info | Extra information available after response code. |
| virtual int PInternetProtocol::ExecuteCommand | ( | PINDEX | cmdNumber | ) | [virtual] |
Write a command to the socket, using WriteCommand() and await a response using ReadResponse(). The first character of the response is returned, as well as the entire response being saved into the protected member variables lastResponseCode and lastResponseInfo.
This function is typically used by client forms of the socket.
| cmdNumber | Number of command to write. |
| virtual int PInternetProtocol::ExecuteCommand | ( | PINDEX | cmdNumber, | |
| const PString & | param | |||
| ) | [virtual] |
| cmdNumber | Number of command to write. |
| param | Extra parameters required by the command. |
| int PInternetProtocol::GetLastResponseCode | ( | ) | const |
Return the code associated with the last response received by the socket.
| PString PInternetProtocol::GetLastResponseInfo | ( | ) | const |
Return the last response received by the socket.
| virtual PINDEX PInternetProtocol::ParseResponse | ( | const PString & | line | ) | [protected, virtual] |
Parse a response line string into a response code and any extra info on the line. Results are placed into the member variables lastResponseCode and lastResponseInfo.
The default bahaviour looks for a space or a '-' and splits the code and info either side of that character, then returns PFalse.
| line | Input response line to be parsed |
Reimplemented in PPOP3.
PString PInternetProtocol::defaultServiceName [protected] |
PStringArray PInternetProtocol::commandNames [protected] |
PCharArray PInternetProtocol::unReadBuffer [protected] |
PINDEX PInternetProtocol::unReadCount [protected] |
PTimeInterval PInternetProtocol::readLineTimeout [protected] |
enum PInternetProtocol::StuffState PInternetProtocol::stuffingState [protected] |
PBoolean PInternetProtocol::newLineToCRLF [protected] |
int PInternetProtocol::lastResponseCode [protected] |
PString PInternetProtocol::lastResponseInfo [protected] |
1.5.1