|
|
| Context (PCLI &cli) |
| Construct new command line interpreter context. More...
|
|
virtual | ~Context () |
| Destroy command line interpreter context. More...
|
|
|
virtual PBoolean | Write (const void *buf, PINDEX len) |
| Low level write to the channel. More...
|
|
|
bool | Start () |
| Start a command line interpreter thread. More...
|
|
void | Stop () |
| Stop command line interpreter context. More...
|
|
virtual void | OnStart () |
| Call back frunction for when context is started. More...
|
|
virtual void | OnStop () |
| Callback for when context is stopping. More...
|
|
virtual bool | WritePrompt () |
| Write prompt (depending on state) to channel. More...
|
|
virtual bool | ReadAndProcessInput () |
| Read a character from the attached channel an process. More...
|
|
virtual bool | ProcessInput (int ch) |
| Process a character read from the channel. More...
|
|
virtual bool | ProcessInput (const PString &line) |
|
virtual void | OnCompletedLine () |
| Call back for a command line was completed and ENTER pressed. More...
|
|
|
PCLI & | GetCLI () const |
| Get the CLI. More...
|
|
bool | IsProcessingCommand () const |
| Indicate is currently processing a command. 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 | Read (void *buf, PINDEX len) |
| Low level read from the channel. 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 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 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 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...
|
|
Context for command line interpreter.