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 TCP/IP socket for process/application layer high level protocols. All of these protocols execute commands and responses in a standard manner.
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.
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.
- Returns:
- TRUE if something was read, otherwise an I/O error occurred.
- Parameters:
-
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. |
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 FALSE.
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.
- Returns:
- TRUE if a CR/LF pair was received, FALSE if a timeout or error occurred.
- Parameters:
-
line | String to receive a CR/LF terminated line. |
allowContinuation | Flag to handle continued lines. |
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.
- Returns:
- TRUE if the response was completely read without a socket error.
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 TRUE then all occurrences of a '
' character will be translated to a CR/LF pair.
- 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 PIndirectChannel.
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 FALSE.
This function is typically used by client forms of the socket.
- Returns:
- TRUE if the command was completely written.
- Parameters:
-
cmdNumber | Number of command to write. |
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.
- Returns:
- TRUE if the response was completely written.
- Parameters:
-
numericCode | Response code for command response. |
info | Extra information available after response code. |