#include <RS232DataIO.h>
Inheritance diagram for RS232DataIO:
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 | |
| RS232DataIO (const char *portName, uint32 baudRate, bool blocking) | |
| Constructor. | |
| virtual | ~RS232DataIO () |
| Destructor. | |
| virtual int32 | Read (void *buffer, uint32 size) |
| Tries to place (size) bytes of new data into (buffer). | |
| virtual int32 | Write (const void *buffer, uint32 size) |
| Takes (size) bytes from (buffer) and pushes them in to the outgoing I/O stream. | |
| virtual status_t | Seek (int64, int) |
| Always returns B_ERROR, since you can't seek on a serial port! | |
| virtual int64 | GetPosition () const |
| Always returns -1, since a serial port has no position to speak of. | |
| virtual void | FlushOutput () |
| Doesn't return until all outgoing serial bytes have been sent. | |
| virtual void | Shutdown () |
| Closes our held serial port. | |
| virtual const SocketRef & | GetSelectSocket () const |
| Returns a socket that can be select()'d on for notifications of read/write availability. | |
| bool | IsPortAvailable () const |
| Returns true iff we have a valid serial port to communicate through. | |
| 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 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. | |
Static Public Member Functions | |
| static status_t | GetAvailableSerialPortNames (Queue< String > &retList) |
| Returns a list of serial port names that are present on this machine. | |
Note that this class currently only works under Windows, OS/X and Linux, and offers only minimal control of the serial parameters (baud rate only at the moment). On the plus side, it provides a serial-port-socket for use with select(), even under Windows.
Definition at line 18 of file RS232DataIO.h.
anonymous enum [inherited] |
Values to pass in to DataIO::Seek()'s second parameter.
| RS232DataIO::RS232DataIO | ( | const char * | portName, | |
| uint32 | baudRate, | |||
| bool | blocking | |||
| ) |
Constructor.
| portName | The port to open for this IO gateway to use. | |
| baudRate | The baud rate to communicate at. | |
| blocking | If true, I/O will be blocking; else non-blocking. |
| virtual int32 RS232DataIO::Read | ( | void * | buffer, | |
| uint32 | size | |||
| ) | [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. |
Implements DataIO.
| virtual int32 RS232DataIO::Write | ( | const void * | buffer, | |
| uint32 | size | |||
| ) | [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. |
Implements DataIO.
| virtual const SocketRef& RS232DataIO::GetSelectSocket | ( | ) | const [virtual] |
Returns a socket that can be select()'d on for notifications of read/write availability.
Even works under Windows (in non-blocking mode, anyway), despite Microsoft's best efforts to make such a thing impossible :^P Note that you should only use this socket with select(); to read or write to/from the serial port, call Read() and Write() instead.
Implements DataIO.
Returns a list of serial port names that are present on this machine.
These names may be passed in to the constructor of this class verbatim.
| retList | On success, this list will contain serial port names. |
| virtual uint64 DataIO::GetOutputStallLimit | ( | ) | const [inline, virtual, inherited] |
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 status_t DataIO::GetReadByteTimeStamp | ( | int32 | whichByte, | |
| uint64 & | retStamp | |||
| ) | const [inline, virtual, inherited] |
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, inherited] |
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, inherited] |
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 | |||
| ) | [inherited] |
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 | |||
| ) | [inherited] |
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, inherited] |
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