#include <inetprot.h>
Inheritance diagram for PInternetProtocol:
Public Member Functions | |
virtual BOOL | Read (void *buf, PINDEX len) |
virtual BOOL | Write (const void *buf, PINDEX len) |
void | SetReadLineTimeout (const PTimeInterval &t) |
virtual BOOL | Connect (const PString &address, WORD port=0) |
virtual BOOL | Connect (const PString &address, const PString &service) |
virtual BOOL | Accept (PSocket &listener) |
const PString & | GetDefaultService () const |
PIPSocket * | GetSocket () const |
virtual BOOL | WriteLine (const PString &line) |
virtual BOOL | ReadLine (PString &line, BOOL allowContinuation=FALSE) |
virtual void | UnRead (int ch) |
virtual void | UnRead (const PString &str) |
virtual void | UnRead (const void *buffer, PINDEX len) |
virtual BOOL | WriteCommand (PINDEX cmdNumber) |
virtual BOOL | WriteCommand (PINDEX cmdNumber, const PString ¶m) |
virtual BOOL | ReadCommand (PINDEX &num, PString &args) |
virtual BOOL | WriteResponse (unsigned numericCode, const PString &info) |
virtual BOOL | WriteResponse (const PString &code, const PString &info) |
virtual BOOL | ReadResponse () |
virtual BOOL | 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 |
BOOL | 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.
|
|
|
|
|
Accept a server socket to a remote host for the internet protocol.
|
|
|
|
Connect a socket to a remote host for the internet protocol.
|
|
|
|
Write a command to the socket, using This function is typically used by client forms of the socket.
|
|
Get the default service name or port number to use in socket connections.
|
|
Return the code associated with the last response received by the socket.
|
|
Return the last response received by the socket.
|
|
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.
|
|
Parse a response line string into a response code and any extra info on the line. Results are placed into the member variables The default bahaviour looks for a space or a '-' and splits the code and info either side of that character, then returns FALSE.
|
|
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.
Reimplemented from PIndirectChannel. |
|
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
If the command does not match any of the command names then the entire line is placed in the 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.
|
|
Read a string from the socket channel up to a CR/LF pair.
If the
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
|
|
|
|
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
The first form places the response code and info into the protected member variables This function is typically used by client forms of the socket.
|
|
Set the maximum timeout between characters within a line. Default value is 10 seconds. |
|
|
|
|
|
Put back the characters into the data stream so that the next Read() function call will return them first.
|
|
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
Reimplemented from PIndirectChannel. |
|
|
|
Write a single line for a command. The command name for the command number is output, then a space, the the
If the This function is typically used by client forms of the 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
|
|
|
|
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 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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|