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

Public Member Functions

 IsochronousWriteChannel () noexcept
 
 IsochronousWriteChannel (IsochronousWriteChannelImpl *_writeChannel)
 
 IsochronousWriteChannel (const IsochronousWriteChannel &copy) noexcept
 
IsochronousWriteChanneloperator= (const IsochronousWriteChannel &assign) noexcept
 
uint64 getSubchannels ()
 
void cancel ()
 
void close ()
 
IsochronousWritePacketsRequest getWritePacketsRequest () const noexcept
 
IsochronousWriteFixedPacketsRequest getWriteFixedPacketsRequest () const noexcept
 
IsochronousWriteDataRequest getWriteDataRequest () const noexcept
 
void queue (IsochronousWriteRequest &request)
 
void queue (IsochronousWritePacketsRequest &request)
 
void queue (IsochronousWriteFixedPacketsRequest &request)
 
void queue (IsochronousWriteDataRequest &request)
 
void queue (Allocator< IsochronousWriteRequest > &request)
 
IsochronousWriteRequest dequeue ()
 
bool wait (unsigned int microseconds)
 

Constructor & Destructor Documentation

◆ IsochronousWriteChannel() [1/3]

IEEE1394Common::IsochronousWriteChannel::IsochronousWriteChannel ( )
inlinenoexcept

Initializes channel as closed.

◆ IsochronousWriteChannel() [2/3]

IEEE1394Common::IsochronousWriteChannel::IsochronousWriteChannel ( IsochronousWriteChannelImpl _writeChannel)
inline

Initializes write channel.

◆ IsochronousWriteChannel() [3/3]

IEEE1394Common::IsochronousWriteChannel::IsochronousWriteChannel ( const IsochronousWriteChannel copy)
inlinenoexcept

Initializes channel from other channel.

Member Function Documentation

◆ cancel()

void IEEE1394Common::IsochronousWriteChannel::cancel ( )
inline

Cancels all pending requests.

◆ close()

void IEEE1394Common::IsochronousWriteChannel::close ( )
inline

Closes the channel.

◆ dequeue()

IsochronousWriteRequest IEEE1394Common::IsochronousWriteChannel::dequeue ( )
inline

Returns the next completed request.

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

◆ getSubchannels()

uint64 IEEE1394Common::IsochronousWriteChannel::getSubchannels ( )
inline

Returns the reserved subchannels.

◆ getWriteDataRequest()

IsochronousWriteDataRequest IEEE1394Common::IsochronousWriteChannel::getWriteDataRequest ( ) const
inlinenoexcept

Returns a write data request object (WRITE_DATA_REQUEST).

◆ getWriteFixedPacketsRequest()

IsochronousWriteFixedPacketsRequest IEEE1394Common::IsochronousWriteChannel::getWriteFixedPacketsRequest ( ) const
inlinenoexcept

Returns a write fixed packet request object (WRITE_FIXED_PACKETS_REQUEST).

◆ getWritePacketsRequest()

IsochronousWritePacketsRequest IEEE1394Common::IsochronousWriteChannel::getWritePacketsRequest ( ) const
inlinenoexcept

Returns a write packet request object (WRITE_PACKETS_REQUEST).

◆ operator=()

IsochronousWriteChannel& IEEE1394Common::IsochronousWriteChannel::operator= ( const IsochronousWriteChannel assign)
inlinenoexcept

Assignment of channel by channel.

◆ queue() [1/5]

void IEEE1394Common::IsochronousWriteChannel::queue ( Allocator< IsochronousWriteRequest > &  request)
inline

Queues the specified write requests.

◆ queue() [2/5]

void IEEE1394Common::IsochronousWriteChannel::queue ( IsochronousWriteDataRequest request)
inline

Queues the specified write request.

◆ queue() [3/5]

void IEEE1394Common::IsochronousWriteChannel::queue ( IsochronousWriteFixedPacketsRequest request)
inline

Queues the specified write request.

◆ queue() [4/5]

void IEEE1394Common::IsochronousWriteChannel::queue ( IsochronousWritePacketsRequest request)
inline

Queues the specified write request.

◆ queue() [5/5]

void IEEE1394Common::IsochronousWriteChannel::queue ( IsochronousWriteRequest request)
inline

Queues the specified write request.

◆ wait()

bool IEEE1394Common::IsochronousWriteChannel::wait ( unsigned int  microseconds)
inline

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.