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

Isochronous write channel. More...

#include <base/communication/IEEE1394Common.h>

Inherits ReferenceCountedObject.

Public Member Functions

virtual uint64 getSubchannels ()
 
virtual void cancel ()
 
virtual IsochronousWritePacketsRequest getWritePacketsRequest () const
 
virtual IsochronousWriteFixedPacketsRequest getWriteFixedPacketsRequest () const
 
virtual IsochronousWriteDataRequest getWriteDataRequest () const
 
virtual void queue (IsochronousWriteRequest &request)
 
virtual void queue (IsochronousWritePacketsRequest &request)
 
virtual void queue (IsochronousWriteFixedPacketsRequest &request)
 
virtual void queue (IsochronousWriteDataRequest &request)
 
virtual void queue (Allocator< IsochronousWriteRequest > &request)
 
virtual IsochronousWriteRequest dequeue ()
 
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 write channel.

Interface implemented by isochronous write channels.

Version
1.0

Member Function Documentation

◆ cancel()

virtual void IEEE1394Common::IsochronousWriteChannelImpl::cancel ( )
virtual

Cancels all pending requests.

◆ dequeue()

virtual IsochronousWriteRequest IEEE1394Common::IsochronousWriteChannelImpl::dequeue ( )
virtual

Returns the next completed request.

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

◆ getSubchannels()

virtual uint64 IEEE1394Common::IsochronousWriteChannelImpl::getSubchannels ( )
virtual

Returns the reserved subchannels.

◆ getWriteDataRequest()

virtual IsochronousWriteDataRequest IEEE1394Common::IsochronousWriteChannelImpl::getWriteDataRequest ( ) const
virtual

Returns a write data request object (WRITE_DATA_REQUEST).

◆ getWriteFixedPacketsRequest()

virtual IsochronousWriteFixedPacketsRequest IEEE1394Common::IsochronousWriteChannelImpl::getWriteFixedPacketsRequest ( ) const
virtual

Returns a write fixed packet request object (WRITE_FIXED_PACKETS_REQUEST).

◆ getWritePacketsRequest()

virtual IsochronousWritePacketsRequest IEEE1394Common::IsochronousWriteChannelImpl::getWritePacketsRequest ( ) const
virtual

Returns a write packet request object (WRITE_PACKETS_REQUEST).

◆ queue() [1/5]

virtual void IEEE1394Common::IsochronousWriteChannelImpl::queue ( Allocator< IsochronousWriteRequest > &  request)
virtual

Queues the specified write requests.

◆ queue() [2/5]

virtual void IEEE1394Common::IsochronousWriteChannelImpl::queue ( IsochronousWriteDataRequest request)
virtual

Queues the specified write request.

◆ queue() [3/5]

virtual void IEEE1394Common::IsochronousWriteChannelImpl::queue ( IsochronousWriteFixedPacketsRequest request)
virtual

Queues the specified write request.

◆ queue() [4/5]

virtual void IEEE1394Common::IsochronousWriteChannelImpl::queue ( IsochronousWritePacketsRequest request)
virtual

Queues the specified write request.

◆ queue() [5/5]

virtual void IEEE1394Common::IsochronousWriteChannelImpl::queue ( IsochronousWriteRequest request)
virtual

Queues the specified write request.

◆ wait()

virtual bool IEEE1394Common::IsochronousWriteChannelImpl::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.