#include <output.h>
Inherits object.
Inherited by bytebuffer, filedescriptor, httpresponse, and httpserverapi.
Public Member Functions inherited from Detailed Description
The output class provides a base class for things to which output can be directed (file descriptors, files, sockets, string buffers, etc.)
Constructor & Destructor Documentation
◆ output()
| output::output | ( | ) |
Creates an instance of the output class.
◆ ~output()
|
virtual |
Deletes this instance of the output class.
Member Function Documentation
◆ getPosition()
|
inlinevirtual |
Returns the position at which the next write will occur or -1 on failure.
This implementation of the method ignores "offset" and always returns -1, however a child class might implement this method to actually set the position.
Reimplemented in bytebuffer, filedescriptor, stringbuffer, ucs2stringbuffer, and wstringbuffer.
◆ printBits() [1/9]
| void output::printBits | ( | byte_t | value | ) |
Prints "value" to the output as a string of ones and zeros.
◆ printBits() [2/9]
◆ printBits() [3/9]
Prints "value" to the output as a string of ones and zeros.
◆ printBits() [4/9]
| void output::printBits | ( | int16_t | value | ) |
Prints "value" to the output as a string of ones and zeros.
◆ printBits() [5/9]
| void output::printBits | ( | int32_t | value | ) |
Prints "value" to the output as a string of ones and zeros.
◆ printBits() [6/9]
| void output::printBits | ( | int64_t | value | ) |
Prints "value" to the output as a string of ones and zeros.
◆ printBits() [7/9]
| void output::printBits | ( | uint16_t | value | ) |
Prints "value" to the output as a string of ones and zeros.
◆ printBits() [8/9]
| void output::printBits | ( | uint32_t | value | ) |
Prints "value" to the output as a string of ones and zeros.
◆ printBits() [9/9]
| void output::printBits | ( | uint64_t | value | ) |
Prints "value" to the output as a string of ones and zeros.
◆ printf() [1/4]
Writes "argp" using "format" which should comply with standard printf formatting rules.
Note that argp is a pointer to a va_list, not just a va_list.
Returns the number of bytes written.
NOTE: The various implemententations of this method use whatever underlying v(d/s/f)printf() functions are available, which, as it turns out, yield fairly inconsistent results between each other, especially across platforms, when printing wide characters. Don't be surprised if you get different results, when printf()ing wide strings to a stringbuffer vs. filedescriptor, or to a buffered vs. unbuffered file descriptor.
◆ printf() [2/4]
Writes "..." using "format" which should comply with standard printf formatting rules.
Returns the number of bytes written or -1 if an error occurred.
NOTE: The various implemententations of this method use whatever underlying v(d/s/f)printf() functions are available, which, as it turns out, yield fairly inconsistent results between each other, especially across platforms, when printing wide characters. Don't be surprised if you get different results, when printf()ing wide strings to a stringbuffer vs. filedescriptor, or to a buffered vs. unbuffered file descriptor.
◆ printf() [3/4]
Writes "argp" using "format" which should comply with standard wprintf formatting rules.
Note that argp is a pointer to a va_list, not just a va_list.
Returns the number of bytes written.
NOTE: The various implemententations of this method use whatever underlying v(d/s/f)printf() functions are available, which, as it turns out, yield fairly inconsistent results between each other, especially across platforms, when printing wide characters. Don't be surprised if you get different results, when printf()ing wide strings to a stringbuffer vs. filedescriptor, or to a buffered vs. unbuffered file descriptor.
◆ printf() [4/4]
Writes "..." using "format" which should comply with standard wprintf formatting rules.
Returns the number of bytes written or -1 if an error occurred.
NOTE: The various implemententations of this method use whatever underlying v(d/s/f)printf() functions are available, which, as it turns out, yield fairly inconsistent results between each other, especially across platforms, when printing wide characters. Don't be surprised if you get different results, when printf()ing wide strings to a stringbuffer vs. filedescriptor, or to a buffered vs. unbuffered file descriptor.
◆ printfUcs2() [1/2]
Writes "argp" using "format" which should comply with standard wprintf formatting rules.
Note that argp is a pointer to a va_list, not just a va_list.
Returns the number of bytes written.
NOTE: The various implemententations of this method use whatever underlying v(d/s/f)printf() functions are available, which, as it turns out, yield fairly inconsistent results between each other, especially across platforms, when printing wide characters. Don't be surprised if you get different results, when printf()ing wide strings to a stringbuffer vs. filedescriptor, or to a buffered vs. unbuffered file descriptor.
◆ printfUcs2() [2/2]
|
inlinevirtual |
Writes "..." using "format" which should comply with standard wprintf formatting rules.
Returns the number of bytes written or -1 if an error occurred.
NOTE: The various implemententations of this method use whatever underlying v(d/s/f)printf() functions are available, which, as it turns out, yield fairly inconsistent results between each other, especially across platforms, when printing wide characters. Don't be surprised if you get different results, when printf()ing wide strings to a stringbuffer vs. filedescriptor, or to a buffered vs. unbuffered file descriptor.
◆ printHex() [1/2]
Prints a hex/character representation "size" bytes of "data" to the output.
◆ printHex() [2/2]
Prints a hex/character representation "size" bytes of "data" to the output, indented by "indent" tabs.
◆ safePrint() [1/6]
| void output::safePrint | ( | byte_t | c | ) |
Prints "c" to the output, however if "c" is non-printing character then it is printed as a hex value of the format: (0x0a). Carriage returns, line feeds and tabs are printed as
, \r and \t.
◆ safePrint() [2/6]
Prints "c" to the output, however if "c" is non-printing character then it is printed as a hex value of the format: (0x0a). Carriage returns, line feeds and tabs are printed as
, \r and \t.
◆ safePrint() [3/6]
Prints "str" to the output, however all non-printing characters are printed as hex values of the format: (0x0a) and carriage returns, line feeds and tabs are printed as
, \r and \t.
◆ safePrint() [4/6]
Prints "length" characters of "str" to the output, however all non-printing characters are printed as hex values of the format: (0x0a) and carriage returns, line feeds and tabs are printed as
, \r and \t.
◆ safePrint() [5/6]
Prints "str" to the output, however all non-printing characters are printed as hex values of the format: (0x0a) and carriage returns, line feeds and tabs are printed as
, \r and \t.
◆ safePrint() [6/6]
Prints "length" characters of "str" to the output, however all non-printing characters are printed as hex values of the format: (0x0a) and carriage returns, line feeds and tabs are printed as
, \r and \t.
◆ setPositionRelativeToBeginning()
|
inlinevirtual |
Sets the position (relative to the beginning of the file descriptor) at which the next write will occur to "offset". Returns that position on success or -1 on failure.
This implementation of the method ignores "offset" and always returns -1, however a child class might implement this method to actually set the position.
Reimplemented in bytebuffer, filedescriptor, stringbuffer, ucs2stringbuffer, and wstringbuffer.
◆ setPositionRelativeToCurrent()
|
inlinevirtual |
Advances the position at which the next write will occur by "offset" bytes. Returns that position on success or -1 on failure.
This implementation of the method ignores "offset" and always returns -1, however a child class might implement this method to actually set the position.
Reimplemented in bytebuffer, filedescriptor, stringbuffer, ucs2stringbuffer, and wstringbuffer.
◆ setPositionRelativeToEnd()
|
inlinevirtual |
Sets the position at which the next write will occur to the end of the file plus "offset" bytes. Generally, "offset" will be negative. Returns the position on success or -1 on failure.
This implementation of the method ignores "offset" and always returns -1, however a child class might implement this method to actually set the position.
Reimplemented in bytebuffer, filedescriptor, stringbuffer, ucs2stringbuffer, and wstringbuffer.
◆ write() [1/32]
|
pure virtual |
Writes "character" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
Implemented in bytebuffer, filedescriptor, httpresponse, stringbuffer, and ucs2stringbuffer.
◆ write() [2/32]
|
virtual |
Writes "character" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
In this implementation of the method, "sec" and "usec" are ignored, however a child class might implement a timeout using them. In that case, the method would return RESULT_TIMEOUT if a timeout occurred.
Reimplemented in filedescriptor.
◆ write() [3/32]
Writes "character" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
Implemented in bytebuffer, filedescriptor, httpresponse, and stringbuffer.
◆ write() [4/32]
Writes "character" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
In this implementation of the method, "sec" and "usec" are ignored, however a child class might implement a timeout using them. In that case, the method would return RESULT_TIMEOUT if a timeout occurred.
Reimplemented in filedescriptor.
◆ write() [5/32]
Writes "size" bytes of "string" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
Implemented in bytebuffer, filedescriptor, httpresponse, stringbuffer, and ucs2stringbuffer.
◆ write() [6/32]
|
virtual |
Writes "size" bytes of "string" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
In this implementation of the method, "sec" and "usec" are ignored, however a child class might implement a timeout using them. In that case, the method would return RESULT_TIMEOUT if a timeout occurred.
Reimplemented in filedescriptor.
◆ write() [7/32]
Writes NULL-terminated "string" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
Implemented in bytebuffer, filedescriptor, httpresponse, and stringbuffer.
◆ write() [8/32]
Writes NULL-terminated "string" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
In this implementation of the method, "sec" and "usec" are ignored, however a child class might implement a timeout using them. In that case, the method would return RESULT_TIMEOUT if a timeout occurred.
Reimplemented in filedescriptor.
◆ write() [9/32]
Writes "length" characters of "string" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred. Note that it is possible to write beyond the string's NULL terminator using this method.
Implemented in bytebuffer, filedescriptor, httpresponse, and stringbuffer.
◆ write() [10/32]
|
virtual |
Writes "length" characters of "string" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred. Note that it is possible to write beyond the string's NULL terminator using this method.
In this implementation of the method, "sec" and "usec" are ignored, however a child class might implement a timeout using them. In that case, the method would return RESULT_TIMEOUT if a timeout occurred.
Reimplemented in filedescriptor.
◆ write() [11/32]
Writes NULL-terminated "string" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
Implemented in bytebuffer, filedescriptor, httpresponse, and wstringbuffer.
◆ write() [12/32]
Writes NULL-terminated "string" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
In this implementation of the method, "sec" and "usec" are ignored, however a child class might implement a timeout using them. In that case, the method would return RESULT_TIMEOUT if a timeout occurred.
Reimplemented in filedescriptor.
◆ write() [13/32]
Writes "length" characters of "string" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred. Note that it is possible to write beyond the string's NULL terminator using this method.
Implemented in bytebuffer, filedescriptor, httpresponse, and wstringbuffer.
◆ write() [14/32]
|
virtual |
Writes "length" characters of "string" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred. Note that it is possible to write beyond the string's NULL terminator using this method.
In this implementation of the method, "sec" and "usec" are ignored, however a child class might implement a timeout using them. In that case, the method would return RESULT_TIMEOUT if a timeout occurred.
Reimplemented in filedescriptor.
◆ write() [15/32]
Writes "number" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
Implemented in bytebuffer, filedescriptor, httpresponse, stringbuffer, ucs2stringbuffer, and wstringbuffer.
◆ write() [16/32]
Writes "number" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
In this implementation of the method, "sec" and "usec" are ignored, however a child class might implement a timeout using them. In that case, the method would return RESULT_TIMEOUT if a timeout occurred.
Reimplemented in filedescriptor.
◆ write() [17/32]
Writes "number" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
Implemented in bytebuffer, filedescriptor, httpresponse, stringbuffer, ucs2stringbuffer, and wstringbuffer.
◆ write() [18/32]
Writes "number" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
In this implementation of the method, "sec" and "usec" are ignored, however a child class might implement a timeout using them. In that case, the method would return RESULT_TIMEOUT if a timeout occurred.
Reimplemented in filedescriptor.
◆ write() [19/32]
|
pure virtual |
Writes "number" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
Implemented in bytebuffer, filedescriptor, httpresponse, stringbuffer, ucs2stringbuffer, and wstringbuffer.
◆ write() [20/32]
|
virtual |
Writes "number" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
In this implementation of the method, "sec" and "usec" are ignored, however a child class might implement a timeout using them. In that case, the method would return RESULT_TIMEOUT if a timeout occurred.
Reimplemented in filedescriptor.
◆ write() [21/32]
|
pure virtual |
Writes "number" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
Implemented in bytebuffer, filedescriptor, httpresponse, stringbuffer, ucs2stringbuffer, and wstringbuffer.
◆ write() [22/32]
|
virtual |
Writes "number" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
In this implementation of the method, "sec" and "usec" are ignored, however a child class might implement a timeout using them. In that case, the method would return RESULT_TIMEOUT if a timeout occurred.
Reimplemented in filedescriptor.
◆ write() [23/32]
|
pure virtual |
Writes "number" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
Implemented in bytebuffer, filedescriptor, httpresponse, stringbuffer, ucs2stringbuffer, and wstringbuffer.
◆ write() [24/32]
|
virtual |
Writes "number" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
In this implementation of the method, "sec" and "usec" are ignored, however a child class might implement a timeout using them. In that case, the method would return RESULT_TIMEOUT if a timeout occurred.
Reimplemented in filedescriptor.
◆ write() [25/32]
|
pure virtual |
Writes "number" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
Implemented in bytebuffer, filedescriptor, httpresponse, stringbuffer, ucs2stringbuffer, and wstringbuffer.
◆ write() [26/32]
|
virtual |
Writes "number" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
In this implementation of the method, "sec" and "usec" are ignored, however a child class might implement a timeout using them. In that case, the method would return RESULT_TIMEOUT if a timeout occurred.
Reimplemented in filedescriptor.
◆ write() [27/32]
|
pure virtual |
Writes "number" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
Implemented in bytebuffer, filedescriptor, httpresponse, stringbuffer, ucs2stringbuffer, and wstringbuffer.
◆ write() [28/32]
|
virtual |
Writes "number" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
In this implementation of the method, "sec" and "usec" are ignored, however a child class might implement a timeout using them. In that case, the method would return RESULT_TIMEOUT if a timeout occurred.
Reimplemented in filedescriptor.
◆ write() [29/32]
|
pure virtual |
Writes "number" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
Implemented in bytebuffer, filedescriptor, httpresponse, stringbuffer, ucs2stringbuffer, and wstringbuffer.
◆ write() [30/32]
|
virtual |
Writes "number" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
In this implementation of the method, "sec" and "usec" are ignored, however a child class might implement a timeout using them. In that case, the method would return RESULT_TIMEOUT if a timeout occurred.
Reimplemented in filedescriptor.
◆ write() [31/32]
Writes "character" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
Implemented in bytebuffer, filedescriptor, httpresponse, and wstringbuffer.
◆ write() [32/32]
Writes "character" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
In this implementation of the method, "sec" and "usec" are ignored, however a child class might implement a timeout using them. In that case, the method would return RESULT_TIMEOUT if a timeout occurred.
Reimplemented in filedescriptor.
◆ writeUcs2() [1/6]
Writes NULL-terminated "string" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
Implemented in bytebuffer, filedescriptor, httpresponse, and ucs2stringbuffer.
◆ writeUcs2() [2/6]
Writes NULL-terminated "string" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
In this implementation of the method, "sec" and "usec" are ignored, however a child class might implement a timeout using them. In that case, the method would return RESULT_TIMEOUT if a timeout occurred.
Reimplemented in filedescriptor.
◆ writeUcs2() [3/6]
Writes "length" characters of "string" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred. Note that it is possible to write beyond the string's NULL terminator using this method.
Implemented in bytebuffer, filedescriptor, httpresponse, and ucs2stringbuffer.
◆ writeUcs2() [4/6]
|
virtual |
Writes "length" characters of "string" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred. Note that it is possible to write beyond the string's NULL terminator using this method.
In this implementation of the method, "sec" and "usec" are ignored, however a child class might implement a timeout using them. In that case, the method would return RESULT_TIMEOUT if a timeout occurred.
Reimplemented in filedescriptor.
◆ writeUcs2() [5/6]
|
pure virtual |
Writes "character" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
Implemented in bytebuffer, filedescriptor, httpresponse, and ucs2stringbuffer.
◆ writeUcs2() [6/6]
|
virtual |
Writes "character" to the file descriptor. Returns the number of bytes that were successfully written or RESULT_ERROR if an error occurred.
In this implementation of the method, "sec" and "usec" are ignored, however a child class might implement a timeout using them. In that case, the method would return RESULT_TIMEOUT if a timeout occurred.
Reimplemented in filedescriptor.
