|
| PPOP3Server () |
| Create a TCP/IP POP3 protocol socket channel. More...
|
|
PBoolean | ProcessCommand () |
| Process commands, dispatching to the appropriate virtual function. More...
|
|
virtual PBoolean | HandleOpenMailbox (const PString &username, const PString &password) |
| Log the specified user into the mail system and return sizes of each message in mail box. More...
|
|
virtual void | HandleSendMessage (PINDEX messageNumber, const PString &id, PINDEX lines) |
| Handle the sending of the specified message to the remote client. More...
|
|
virtual void | HandleDeleteMessage (PINDEX messageNumber, const PString &id) |
| Handle the deleting of the specified message from the mail box. More...
|
|
virtual PBoolean | Read (void *buf, PINDEX len) |
| Low level read from the channel. More...
|
|
virtual PBoolean | Write (const void *buf, PINDEX len) |
| Low level write to the channel. More...
|
|
void | SetReadLineTimeout (const PTimeInterval &t) |
| Set the maximum timeout between characters within a line. More...
|
|
virtual PBoolean | Connect (const PString &address, WORD port=0) |
| Connect a socket to a remote host for the internet protocol. More...
|
|
virtual PBoolean | Connect (const PString &address, const PString &service) |
|
virtual PBoolean | Accept (PSocket &listener) |
| Accept a server socket to a remote host for the internet protocol. More...
|
|
const PString & | GetDefaultService () const |
| Get the default service name or port number to use in socket connections. More...
|
|
PIPSocket * | 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. More...
|
|
virtual PBoolean | WriteLine (const PString &line) |
| Write a string to the socket channel followed by a CR/LF pair. More...
|
|
virtual PBoolean | ReadLine (PString &line, PBoolean allowContinuation=false) |
| Read a string from the socket channel up to a CR/LF pair. More...
|
|
virtual void | UnRead (int ch) |
| Put back the characters into the data stream so that the next Read() function call will return them first. More...
|
|
virtual void | UnRead (const PString &str) |
|
virtual void | UnRead (const void *buffer, PINDEX len) |
|
virtual PBoolean | WriteCommand (PINDEX cmdNumber) |
| Write a single line for a command. More...
|
|
virtual PBoolean | WriteCommand (PINDEX cmdNumber, const PString ¶m) |
|
virtual PBoolean | ReadCommand (PINDEX &num, PString &args) |
| Read a single line of a command which ends with a CR/LF pair. More...
|
|
virtual PBoolean | WriteResponse (unsigned numericCode, const PString &info) |
| Write a response code followed by a text string describing the response to a command. More...
|
|
virtual PBoolean | WriteResponse (const PString &code, const PString &info) |
|
virtual PBoolean | ReadResponse () |
| Read a response code followed by a text string describing the response to a command. More...
|
|
virtual PBoolean | ReadResponse (int &code, PString &info) |
|
virtual int | ExecuteCommand (PINDEX cmdNumber) |
| Write a command to the socket, using WriteCommand() and await a response using ReadResponse() . More...
|
|
virtual int | ExecuteCommand (PINDEX cmdNumber, const PString ¶m) |
|
int | GetLastResponseCode () const |
| Return the code associated with the last response received by the socket. More...
|
|
PString | GetLastResponseInfo () const |
| Return the last response received by the socket. More...
|
|
| PIndirectChannel () |
| Create a new indirect channel without any channels to redirect to. More...
|
|
| ~PIndirectChannel () |
| Close the indirect channel, deleting read/write channels if desired. More...
|
|
Comparison | Compare (const PObject &obj) const |
| Determine if the two objects refer to the same indirect channel. More...
|
|
virtual PString | GetName () const |
| Get the name of the channel. More...
|
|
virtual PBoolean | Close () |
| Close the channel. More...
|
|
virtual PBoolean | IsOpen () const |
| Determine if the channel is currently open and read and write operations can be executed on it. More...
|
|
virtual PBoolean | Shutdown (ShutdownValue option) |
| Close one or both of the data streams associated with a channel. More...
|
|
virtual bool | SetLocalEcho (bool localEcho) |
| Set local echo mode. More...
|
|
virtual PChannel * | GetBaseReadChannel () const |
| This function returns the eventual base channel for reading of a series of indirect channels provided by descendents of PIndirectChannel . More...
|
|
virtual PChannel * | GetBaseWriteChannel () const |
| This function returns the eventual base channel for writing of a series of indirect channels provided by descendents of PIndirectChannel . More...
|
|
virtual PString | GetErrorText (ErrorGroup group=NumErrorGroups) const |
| Get error message description. More...
|
|
PBoolean | Open (PChannel &channel) |
| Set the channel for both read and write operations. More...
|
|
PBoolean | Open (PChannel *channel, PBoolean autoDelete=true) |
| Set the channel for both read and write operations. More...
|
|
PBoolean | Open (PChannel *readChannel, PChannel *writeChannel, PBoolean autoDeleteRead=true, PBoolean autoDeleteWrite=true) |
| Set the channel for both read and write operations. More...
|
|
PChannel * | GetReadChannel () const |
| Get the channel used for read operations. More...
|
|
bool | SetReadChannel (PChannel *channel, bool autoDelete=true, bool closeExisting=false) |
| Set the channel for read operations. More...
|
|
PChannel * | GetWriteChannel () const |
| Get the channel used for write operations. More...
|
|
PBoolean | SetWriteChannel (PChannel *channel, bool autoDelete=true, bool closeExisting=false) |
| Set the channel for read operations. More...
|
|
PBoolean | SetErrorValues (Errors errorCode, int osError, ErrorGroup group=LastGeneralError) |
| Set error values to those specified. More...
|
|
| PChannel () |
| Create the channel. More...
|
|
| ~PChannel () |
| Close down the channel. More...
|
|
virtual PINDEX | HashFunction () const |
| Calculate a hash value for use in sets and dictionaries. More...
|
|
int | GetHandle () const |
| Get the integer operating system handle for the channel. More...
|
|
void | SetReadTimeout (const PTimeInterval &time) |
| Set the timeout for read operations. More...
|
|
PTimeInterval | GetReadTimeout () const |
| Get the timeout for read operations. More...
|
|
virtual PINDEX | GetLastReadCount () const |
| Get the number of bytes read by the last Read() call. More...
|
|
virtual int | ReadChar () |
| Read a single 8 bit byte from the channel. More...
|
|
PBoolean | ReadBlock (void *buf, PINDEX len) |
| Read len bytes into the buffer from the channel. More...
|
|
PString | ReadString (PINDEX len) |
| Read len character into a string from the channel. More...
|
|
virtual PBoolean | ReadAsync (void *buf, PINDEX len) |
| Begin an asynchronous read from channel. More...
|
|
virtual void | OnReadComplete (void *buf, PINDEX len) |
| User callback function for when a ReadAsync() call has completed or timed out. More...
|
|
void | SetWriteTimeout (const PTimeInterval &time) |
| Set the timeout for write operations to complete. More...
|
|
PTimeInterval | GetWriteTimeout () const |
| Get the timeout for write operations to complete. More...
|
|
virtual PBoolean | Write (const void *buf, PINDEX len, const void *mark) |
| Low level write to the channel with marker. More...
|
|
virtual PINDEX | GetLastWriteCount () const |
| Get the number of bytes written by the last Write() call. More...
|
|
PBoolean | WriteChar (int c) |
| Write a single character to the channel. More...
|
|
PBoolean | WriteString (const PString &str) |
| Write a string to the channel. More...
|
|
virtual PBoolean | WriteAsync (const void *buf, PINDEX len) |
| Begin an asynchronous write from channel. More...
|
|
virtual void | OnWriteComplete (const void *buf, PINDEX len) |
| User callback function for when a WriteAsync() call has completed or timed out. More...
|
|
virtual bool | FlowControl (const void *flowData) |
| Flow Control information Pass data to the channel for flowControl determination. More...
|
|
PBoolean | SetBufferSize (PINDEX newSize) |
| Set the iostream buffer size for reads and writes. More...
|
|
PBoolean | SendCommandString (const PString &command) |
| Send a command meta-string. More...
|
|
void | AbortCommandString () |
| Abort a command string that is in progress. More...
|
|
Errors | GetErrorCode (ErrorGroup group=NumErrorGroups) const |
| Get normalised error code. More...
|
|
int | GetErrorNumber (ErrorGroup group=NumErrorGroups) const |
| Get OS errro code. More...
|
|
virtual PBoolean | Read (const VectorOfSlice &slices) |
| Low level scattered read from the channel. More...
|
|
virtual PBoolean | Write (const VectorOfSlice &slices) |
| Low level scattered write to the channel. More...
|
|
virtual | ~PObject () |
|
virtual PObject * | Clone () const |
| Create a copy of the class on the heap. More...
|
|
virtual const char * | GetClass (unsigned ancestor=0) const |
| Get the current dynamic type of the object instance. More...
|
|
PBoolean | IsClass (const char *cls) const |
|
virtual PBoolean | InternalIsDescendant (const char *clsName) const |
| Determine if the dynamic type of the current instance is a descendent of the specified class. More...
|
|
virtual Comparison | CompareObjectMemoryDirect (const PObject &obj) const |
| Determine the byte wise comparison of two objects. More...
|
|
bool | operator== (const PObject &obj) const |
| Compare the two objects. More...
|
|
bool | operator!= (const PObject &obj) const |
| Compare the two objects. More...
|
|
bool | operator< (const PObject &obj) const |
| Compare the two objects. More...
|
|
bool | operator> (const PObject &obj) const |
| Compare the two objects. More...
|
|
bool | operator<= (const PObject &obj) const |
| Compare the two objects. More...
|
|
bool | operator>= (const PObject &obj) const |
| Compare the two objects. More...
|
|
virtual void | PrintOn (ostream &strm) const |
| Output the contents of the object to the stream. More...
|
|
virtual void | ReadFrom (istream &strm) |
| Input the contents of the object from the stream. More...
|
|
A TCP/IP socket for the Post Office Protocol version 3.
When acting as a server, a descendant class would be created to override at least the HandleOpenMailbox(), HandleSendMessage() and HandleDeleteMessage() functions. Other functions may be overridden for further enhancement to the sockets capabilities, but these will give a basic POP3 server functionality.
The server socket thread would continuously call the ProcessMessage() function until it returns false. This will then call the appropriate virtual function on parsing the POP3 protocol.