#include <DataIO.h>
Inheritance diagram for DataIO:
Public Types | |
| enum | { IO_SEEK_SET = 0, IO_SEEK_CUR, IO_SEEK_END, NUM_IO_SEEKS } |
| Values to pass in to DataIO::Seek()'s second parameter. More... | |
Public Member Functions | |
| DataIO () | |
| Default Constructor. | |
| virtual | ~DataIO () |
| Virtual destructor, to keep C++ honest. | |
| virtual int32 | Read (void *buffer, uint32 size)=0 |
| Tries to place (size) bytes of new data into (buffer). | |
| virtual int32 | Write (const void *buffer, uint32 size)=0 |
| Takes (size) bytes from (buffer) and pushes them in to the outgoing I/O stream. | |
| virtual status_t | Seek (int64 offset, int whence)=0 |
| Seek to a given position in the I/O stream. | |
| virtual int64 | GetPosition () const=0 |
| Should return the current position, in bytes, of the stream from its start position, or -1 if the current position is not known. | |
| virtual uint64 | GetOutputStallLimit () const |
| Returns the max number of microseconds to allow for an output stall, before presuming that the I/O is hosed. | |
| virtual void | FlushOutput ()=0 |
| Flushes the output buffer, if possible. | |
| virtual void | Shutdown ()=0 |
| Closes the connection. | |
| virtual const SocketRef & | GetSelectSocket () const=0 |
| If this DataIO is usable with select(), this method should return the SocketRef object containing the file descriptor to select on for this DataIO. | |
| virtual status_t | GetReadByteTimeStamp (int32 whichByte, uint64 &retStamp) const |
| Optional interface for returning information on when a given byte returned by the previous Read() call was received. | |
| virtual bool | HasBufferedOutput () const |
| Optional: If your DataIO subclass is holding buffered data that it wants to output as soon as possible but hasn't been able to yet, then override this method to return true, and that will cause FlushBufferedOutput() to be called ASAP. | |
| virtual void | WriteBufferedOutput () |
| Optional: If this DataIO is holding any buffered output data, this method should be implemented to Write() as much of that data as possible. | |
| uint32 | WriteFully (const void *buffer, uint32 size) |
| Convenience method: Calls Write() in a loop until the entire buffer is written, or until an error occurs. | |
| uint32 | ReadFully (void *buffer, uint32 size) |
| Convenience method: Calls Read() in a loop until the entire buffer is written, or until an error occurs. | |
| virtual int64 | GetLength () |
| Convenience method: Determines the length of this DataIO stream by Seek()'ing to the end of the stream, recording the current seek position, and then Seek()'ing back to the previous position in the stream. | |
| void | IncrementRefCount () const |
| Increments the counter and returns true iff the new value is zero. | |
| bool | DecrementRefCount () const |
| Decrements the counter and returns true iff the new value is zero. | |
| void | SetManager (AbstractObjectManager *manager) |
| Sets the recycle-pointer for this object. | |
| AbstractObjectManager * | GetManager () const |
| Returns this object's current recyler pointer. | |
| uint32 | GetRefCount () const |
| Returns this object's current reference count. | |
Definition at line 11 of file DataIO.h.
| anonymous enum |
Values to pass in to DataIO::Seek()'s second parameter.
| virtual int32 DataIO::Read | ( | void * | buffer, | |
| uint32 | size | |||
| ) | [pure virtual] |
Tries to place (size) bytes of new data into (buffer).
Returns the actual number of bytes placed, or a negative value if there was an error.
| buffer | Buffer to write the bytes into | |
| size | Number of bytes in the buffer. |
Implemented in ByteBufferDataIO, ChildProcessDataIO, FailoverDataIO, FileDataIO, FileDescriptorDataIO, MultiDataIO, NullDataIO, PacketizedDataIO, RS232DataIO, SSLSocketDataIO, StdinDataIO, TCPSocketDataIO, UDPSocketDataIO, XorDataIO, QSocketDataIO, and Win32FileHandleDataIO.
Referenced by FailoverDataIO::Read().
| virtual int32 DataIO::Write | ( | const void * | buffer, | |
| uint32 | size | |||
| ) | [pure virtual] |
Takes (size) bytes from (buffer) and pushes them in to the outgoing I/O stream.
Returns the actual number of bytes read from (buffer) and pushed, or a negative value if there was an error.
| buffer | Buffer to read the bytes from. | |
| size | Number of bytes in the buffer. |
Implemented in ByteBufferDataIO, ChildProcessDataIO, FailoverDataIO, FileDataIO, FileDescriptorDataIO, MultiDataIO, NullDataIO, PacketizedDataIO, RS232DataIO, SSLSocketDataIO, StdinDataIO, TCPSocketDataIO, UDPSocketDataIO, XorDataIO, QSocketDataIO, and Win32FileHandleDataIO.
Referenced by FailoverDataIO::Write().
| virtual status_t DataIO::Seek | ( | int64 | offset, | |
| int | whence | |||
| ) | [pure virtual] |
Seek to a given position in the I/O stream.
May not be supported by a DataIO subclass, in which case B_ERROR will always be returned.
| offset | Byte offset to seek to or by (depending on the next arg) | |
| whence | Set this to IO_SEEK_SET if you want the offset to be relative to the start of the stream; or to IO_SEEK_CUR if it should be relative to the current stream position, or IO_SEEK_END if it should be relative to the end of the stream. |
Implemented in ByteBufferDataIO, ChildProcessDataIO, FailoverDataIO, FileDataIO, FileDescriptorDataIO, MultiDataIO, NullDataIO, PacketizedDataIO, RS232DataIO, StdinDataIO, TCPSocketDataIO, UDPSocketDataIO, XorDataIO, QSocketDataIO, and Win32FileHandleDataIO.
Referenced by FailoverDataIO::Seek().
| virtual uint64 DataIO::GetOutputStallLimit | ( | ) | const [inline, virtual] |
Returns the max number of microseconds to allow for an output stall, before presuming that the I/O is hosed.
Default implementation returns MUSCLE_TIME_NEVER, aka no limit.
Reimplemented in FailoverDataIO, MultiDataIO, PacketizedDataIO, TCPSocketDataIO, and XorDataIO.
Definition at line 72 of file DataIO.h.
Referenced by MultiDataIO::GetOutputStallLimit(), and FailoverDataIO::GetOutputStallLimit().
| virtual void DataIO::FlushOutput | ( | ) | [pure virtual] |
Flushes the output buffer, if possible.
For some implementations, this is a no-op. For others (e.g. TCPSocketDataIO) this can be called to reduced latency of outgoing data blocks.
Implemented in ByteBufferDataIO, ChildProcessDataIO, FailoverDataIO, FileDataIO, FileDescriptorDataIO, MultiDataIO, NullDataIO, PacketizedDataIO, RS232DataIO, StdinDataIO, TCPSocketDataIO, UDPSocketDataIO, XorDataIO, QSocketDataIO, and Win32FileHandleDataIO.
Referenced by FailoverDataIO::FlushOutput().
| virtual void DataIO::Shutdown | ( | ) | [pure virtual] |
Closes the connection.
After calling this method, the DataIO object should not be used any more.
Implemented in ByteBufferDataIO, ChildProcessDataIO, FailoverDataIO, FileDataIO, FileDescriptorDataIO, MultiDataIO, NullDataIO, PacketizedDataIO, RS232DataIO, SSLSocketDataIO, StdinDataIO, TCPSocketDataIO, UDPSocketDataIO, XorDataIO, QSocketDataIO, and Win32FileHandleDataIO.
| virtual const SocketRef& DataIO::GetSelectSocket | ( | ) | const [pure virtual] |
If this DataIO is usable with select(), this method should return the SocketRef object containing the file descriptor to select on for this DataIO.
If this DataIO isn't usable with select(), then this method should return GetNullSocket().
Note that the only thing you are allowed to do with the returned file descriptor is pass it to select(). For all other operations, use the appropriate methods in the DataIO interface. If you attempt to do any other I/O operations on this file descriptor directly, the results are non-portable and undefined and will probably break your program.
Implemented in ByteBufferDataIO, ChildProcessDataIO, FailoverDataIO, FileDataIO, FileDescriptorDataIO, MultiDataIO, NullDataIO, PacketizedDataIO, RS232DataIO, StdinDataIO, TCPSocketDataIO, UDPSocketDataIO, XorDataIO, QSocketDataIO, and Win32FileHandleDataIO.
Referenced by MultiDataIO::GetSelectSocket(), and FailoverDataIO::GetSelectSocket().
| virtual status_t DataIO::GetReadByteTimeStamp | ( | int32 | whichByte, | |
| uint64 & | retStamp | |||
| ) | const [inline, virtual] |
Optional interface for returning information on when a given byte returned by the previous Read() call was received.
Not implemented by default, and not implemented by any of the standard MUSCLE DataIO subclasses. (Used by an LCS dataIO class that needs precision timing)
| whichByte | Index of the byte in the previously returned read-buffer that you are interested in. | |
| retStamp | On success, this value is set to the timestamp of the byte. |
Reimplemented in FailoverDataIO, MultiDataIO, and XorDataIO.
Definition at line 114 of file DataIO.h.
Referenced by MultiDataIO::GetReadByteTimeStamp(), and FailoverDataIO::GetReadByteTimeStamp().
| virtual bool DataIO::HasBufferedOutput | ( | ) | const [inline, virtual] |
Optional: If your DataIO subclass is holding buffered data that it wants to output as soon as possible but hasn't been able to yet, then override this method to return true, and that will cause FlushBufferedOutput() to be called ASAP.
Default implementation always returns false.
Reimplemented in FailoverDataIO, MultiDataIO, PacketizedDataIO, and XorDataIO.
Definition at line 123 of file DataIO.h.
Referenced by FailoverDataIO::HasBufferedOutput().
| virtual void DataIO::WriteBufferedOutput | ( | ) | [inline, virtual] |
Optional: If this DataIO is holding any buffered output data, this method should be implemented to Write() as much of that data as possible.
Default implementation is a no-op.
Reimplemented in FailoverDataIO, MultiDataIO, PacketizedDataIO, and XorDataIO.
Definition at line 130 of file DataIO.h.
Referenced by FailoverDataIO::WriteBufferedOutput().
| uint32 DataIO::WriteFully | ( | const void * | buffer, | |
| uint32 | size | |||
| ) |
Convenience method: Calls Write() in a loop until the entire buffer is written, or until an error occurs.
This method should only be used in conjunction with blocking I/O; it will not work reliably with non-blocking I/O.
| buffer | Pointer to the first byte of the buffer to write data from. | |
| size | Number of bytes to write |
| uint32 DataIO::ReadFully | ( | void * | buffer, | |
| uint32 | size | |||
| ) |
Convenience method: Calls Read() in a loop until the entire buffer is written, or until an error occurs.
This method should only be used in conjunction with blocking I/O; it will not work reliably with non-blocking I/O.
| buffer | Pointer to the first byte of the buffer to place the read data into. | |
| size | Number of bytes to read |
| virtual int64 DataIO::GetLength | ( | ) | [virtual] |
Convenience method: Determines the length of this DataIO stream by Seek()'ing to the end of the stream, recording the current seek position, and then Seek()'ing back to the previous position in the stream.
Of course this only works with DataIOs that support seeking and have a fixed length.
Reimplemented in PacketizedDataIO.
| void RefCountable::IncrementRefCount | ( | ) | const [inline, inherited] |
Increments the counter and returns true iff the new value is zero.
Thread safe.
Definition at line 32 of file RefCount.h.
References AtomicCounter::AtomicIncrement().
| bool RefCountable::DecrementRefCount | ( | ) | const [inline, inherited] |
Decrements the counter and returns true iff the new value is zero.
Thread safe.
Definition at line 35 of file RefCount.h.
References AtomicCounter::AtomicDecrement().
| void RefCountable::SetManager | ( | AbstractObjectManager * | manager | ) | [inline, inherited] |
Sets the recycle-pointer for this object.
If set to non-NULL, this pointer is used by the ObjectPool class to recycle this object when it is no longer in use, so as to avoid the overhead of having to delete it and re-create it later on. The RefCountable class itself does nothing with this pointer. Default value is NULL.
| manager | Pointer to the new manager object to use, or NULL to use no manager. |
Definition at line 44 of file RefCount.h.
| uint32 RefCountable::GetRefCount | ( | ) | const [inline, inherited] |
Returns this object's current reference count.
Note that the value returned by this method is volatile in multithreaded environments, so it may already be wrong by the time it is returned. Be careful!
Definition at line 54 of file RefCount.h.
References AtomicCounter::GetCount().
1.5.1