Base Framework
Public Member Functions | List of all members
IEEE1394Common::IsochronousReadChannelImpl Class Reference

Isochronous read channel. More...

#include <base/communication/IEEE1394Common.h>

Inherits ReferenceCountedObject.

Public Member Functions

virtual uint64 getSubchannels ()
 
virtual void cancel ()
 
virtual IsochronousReadPacketsRequest getReadPacketsRequest () const
 
virtual IsochronousReadFixedPacketsRequest getReadFixedPacketsRequest () const
 
virtual IsochronousReadFixedDataRequest getReadFixedDataRequest () const
 
virtual void queue (IsochronousReadRequest &request)
 
virtual void queue (IsochronousReadPacketsRequest &request)
 
virtual void queue (IsochronousReadFixedPacketsRequest &request)
 
virtual void queue (IsochronousReadFixedDataRequest &request)
 
virtual void queue (Allocator< IsochronousReadRequest > &request)
 
virtual IsochronousReadRequest dequeue ()
 
virtual unsigned int dequeue (unsigned int requests, unsigned int microseconds)
 
virtual bool wait (unsigned int microseconds)
 
- Public Member Functions inherited from ReferenceCountedObject
 ReferenceCountedObject () noexcept
 
 ReferenceCountedObject (const ReferenceCountedObject &copy) noexcept
 
 ReferenceCountedObject (ReferenceCountedObject &&move) noexcept
 
ReferenceCountedObjectoperator= (const ReferenceCountedObject &copy) noexcept
 
ReferenceCountedObjectoperator= (ReferenceCountedObject &&move) noexcept
 
MemorySize getNumberOfReferences_INTERNAL () const noexcept
 
virtual bool useGarbageCollector () const noexcept
 
- Public Member Functions inherited from DynamicObject
 DynamicObject () noexcept
 
bool isValidObject () const noexcept
 
virtual ~DynamicObject () noexcept(false)
 
 _COM_AZURE_DEV__BASE__OVERRIDE_ALLOC ()
 

Detailed Description

Isochronous read channel.

Interface implemented by isochronous read channels.

Version
1.0

Member Function Documentation

◆ cancel()

virtual void IEEE1394Common::IsochronousReadChannelImpl::cancel ( )
virtual

Cancels all pending requests.

◆ dequeue() [1/2]

virtual IsochronousReadRequest IEEE1394Common::IsochronousReadChannelImpl::dequeue ( )
virtual

Returns the next completed request.

Returns
NOT_A_REQUEST if no request is available in the completion queue.

◆ dequeue() [2/2]

virtual unsigned int IEEE1394Common::IsochronousReadChannelImpl::dequeue ( unsigned int  requests,
unsigned int  microseconds 
)
virtual

Dequeues the specified number of requests.

Parameters
requestThe number of request to dequeue.
microsecondsThe timeout period in microseconds [0; 999999999].
Returns
The number of dequeued requests.

◆ getReadFixedDataRequest()

virtual IsochronousReadFixedDataRequest IEEE1394Common::IsochronousReadChannelImpl::getReadFixedDataRequest ( ) const
virtual

Returns a read fixed data request object (READ_FIXED_DATA_REQUEST).

◆ getReadFixedPacketsRequest()

virtual IsochronousReadFixedPacketsRequest IEEE1394Common::IsochronousReadChannelImpl::getReadFixedPacketsRequest ( ) const
virtual

Returns a read fixed packet request object (READ_FIXED_PACKETS_REQUEST).

◆ getReadPacketsRequest()

virtual IsochronousReadPacketsRequest IEEE1394Common::IsochronousReadChannelImpl::getReadPacketsRequest ( ) const
virtual

Returns a read packet request object (READ_PACKETS_REQUEST).

◆ getSubchannels()

virtual uint64 IEEE1394Common::IsochronousReadChannelImpl::getSubchannels ( )
virtual

Returns the reserved subchannels.

◆ queue() [1/5]

virtual void IEEE1394Common::IsochronousReadChannelImpl::queue ( Allocator< IsochronousReadRequest > &  request)
virtual

Queues the specified read requests.

◆ queue() [2/5]

virtual void IEEE1394Common::IsochronousReadChannelImpl::queue ( IsochronousReadFixedDataRequest request)
virtual

Queues the specified read request.

◆ queue() [3/5]

virtual void IEEE1394Common::IsochronousReadChannelImpl::queue ( IsochronousReadFixedPacketsRequest request)
virtual

Queues the specified read request.

◆ queue() [4/5]

virtual void IEEE1394Common::IsochronousReadChannelImpl::queue ( IsochronousReadPacketsRequest request)
virtual

Queues the specified read request.

◆ queue() [5/5]

virtual void IEEE1394Common::IsochronousReadChannelImpl::queue ( IsochronousReadRequest request)
virtual

Queues the specified read request.

◆ wait()

virtual bool IEEE1394Common::IsochronousReadChannelImpl::wait ( unsigned int  microseconds)
virtual

Wait for an event.

Parameters
microsecondsThe timeout period in microseconds [0; 999999999].
Returns
True if event occured within the specified timeout period and otherwise false.