UTIOStreams.h File Reference

Go to the source code of this file.

Classes

class  InputStream_t
 Generic input stream interface. More...
class  OutputStream_t
 Generic output stream interface. More...
class  IOStream_t
class  BufferIOStream_t
 I/O stream which reads from or writes to a Buffer_t object. More...

Defines

#define debug_file_func_in(file, from_thread, func, format, a1, a2)   IOStream_t::FunctionIn( file, from_thread, func, format, a1, a2 )
#define debug_file_func_return_statuscode(file, from_thread, status)   IOStream_t::FunctionReturnStatusCode( file, from_thread, __LINE__, status )
#define debug_file_func_return(file, from_thread)   IOStream_t::FunctionReturn( file, from_thread, __LINE__ )
#define debug_file_func_state1(file, from_thread, format, a1)   IOStream_t::FunctionLogState( file, from_thread, __LINE__, format, a1 )
#define debug_file_func_state2(file, from_thread, format, a1, a2)   IOStream_t::FunctionLogState( file, from_thread, __LINE__, format, a1, a2 )
#define debug_file_func_read_start(file, from_thread, pos, bytes_to_read, all)   IOStream_t::FunctionReadStart( file, from_thread, __LINE__, pos, bytes_to_read, all )
#define debug_file_func_read_data(file, from_thread, buffer, pos, bytes_read)   IOStream_t::FunctionReadData( file, from_thread, __LINE__, buffer, pos, bytes_read )
#define debug_file_func_write_data(file, from_thread, what, buffer, pos, bytes_to_write, all)

Define Documentation

#define debug_file_func_in ( file,
from_thread,
func,
format,
a1,
a2   )     IOStream_t::FunctionIn( file, from_thread, func, format, a1, a2 )

Logs entry into a function for an object which may be subject to file operation logging. This macro and the other debug_file_func_ macros will be stripped at compile time by the preprocessor if LOG_FILE_OPS was not defined. from_thread should be true if the logging is occuring form a helper thread associated with the IOStream_t subclass.

Definition at line 495 of file UTIOStreams.h.

#define debug_file_func_return_statuscode ( file,
from_thread,
status   )     IOStream_t::FunctionReturnStatusCode( file, from_thread, __LINE__, status )

Logs return from a function for an object which may be subject to file operation logging. This macro and the other debug_file_func_ macros will be stripped at compile time by the preprocessor if LOG_FILE_OPS was not defined. from_thread should be true if the logging is occuring form a helper thread associated with the IOStream_t subclass.

Definition at line 502 of file UTIOStreams.h.

#define debug_file_func_return ( file,
from_thread   )     IOStream_t::FunctionReturn( file, from_thread, __LINE__ )

Logs return from a function for an object which may be subject to file operation logging. This macro and the other debug_file_func_ macros will be stripped at compile time by the preprocessor if LOG_FILE_OPS was not defined. from_thread should be true if the logging is occuring form a helper thread associated with the IOStream_t subclass.

Definition at line 509 of file UTIOStreams.h.

#define debug_file_func_state1 ( file,
from_thread,
format,
a1   )     IOStream_t::FunctionLogState( file, from_thread, __LINE__, format, a1 )

Logs state in a function for an object which may be subject to file operation logging with a format string and one argument. If the argument is not needed, simply pass zero and make sure that the format string doesn't have a reference-to-vararg component. This macro and the other debug_file_func_ macros will be stripped at compile time by the preprocessor if LOG_FILE_OPS was not defined. from_thread should be true if the logging is occuring form a helper thread associated with the IOStream_t subclass.

Definition at line 518 of file UTIOStreams.h.

#define debug_file_func_state2 ( file,
from_thread,
format,
a1,
a2   )     IOStream_t::FunctionLogState( file, from_thread, __LINE__, format, a1, a2 )

Logs state in a function for an object which may be subject to file operation logging with a format string and two arguments. This macro and the other debug_file_func_ macros will be stripped at compile time by the preprocessor if LOG_FILE_OPS was not defined. from_thread should be true if the logging is occuring form a helper thread associated with the IOStream_t subclass.

Definition at line 526 of file UTIOStreams.h.

#define debug_file_func_read_start ( file,
from_thread,
pos,
bytes_to_read,
all   )     IOStream_t::FunctionReadStart( file, from_thread, __LINE__, pos, bytes_to_read, all )

Logs initiation of a read in a function for an object which may be subject to file operation logging. This macro and the other debug_file_func_ macros will be stripped at compile time by the preprocessor if LOG_FILE_OPS was not defined. from_thread should be true if the logging is occuring form a helper thread associated with the IOStream_t subclass.

Definition at line 533 of file UTIOStreams.h.

#define debug_file_func_read_data ( file,
from_thread,
buffer,
pos,
bytes_read   )     IOStream_t::FunctionReadData( file, from_thread, __LINE__, buffer, pos, bytes_read )

Logs completion of a partial or full read in a function for an object which may be subject to file operation logging. This macro and the other debug_file_func_ macros will be stripped at compile time by the preprocessor if LOG_FILE_OPS was not defined. from_thread should be true if the logging is occuring form a helper thread associated with the IOStream_t subclass.

Definition at line 540 of file UTIOStreams.h.

#define debug_file_func_write_data ( file,
from_thread,
what,
buffer,
pos,
bytes_to_write,
all   ) 
Value:
IOStream_t::FunctionWriteData(  file,                                                          \
                                    from_thread,                                                   \
                                    __LINE__,                                                      \
                                    what,                                                          \
                                    buffer,                                                        \
                                    pos,                                                           \
                                    bytes_to_write,                                                \
                                    all )

Logs completion of a partial or full write in a function for an object which may be subject to file operation logging. The what parameter would typically be "start" with buffer and bytes_to_write being indicative of what is to be written, or "end" with buffer and bytes_to_write being indicative of what has actually been written just before the result was logged. This macro and the other debug_file_func_ macros will be stripped at compile time by the preprocessor if LOG_FILE_OPS was not defined. from_thread should be true if the logging is occuring form a helper thread associated with the IOStream_t subclass.

Definition at line 550 of file UTIOStreams.h.


Generated on Tue Dec 14 22:35:06 2010 for UT library by  doxygen 1.6.1