IEEE1394Common::IsochronousReadChannel Class Reference

Public Member Functions
	IsochronousReadChannel () noexcept
	IsochronousReadChannel (IsochronousReadChannelImpl *_readChannel)
	IsochronousReadChannel (const IsochronousReadChannel &copy) noexcept
IsochronousReadChannel &	operator= (const IsochronousReadChannel &assign) noexcept
uint64	getSubchannels ()
void	cancel ()
void	close ()
IsochronousReadPacketsRequest	getReadPacketsRequest () const noexcept
IsochronousReadFixedPacketsRequest	getReadFixedPacketsRequest () const noexcept
IsochronousReadFixedDataRequest	getReadFixedDataRequest () const noexcept
void	queue (IsochronousReadRequest &request)
void	queue (IsochronousReadPacketsRequest &request)
void	queue (IsochronousReadFixedPacketsRequest &request)
void	queue (IsochronousReadFixedDataRequest &request)
void	queue (Allocator< IsochronousReadRequest > &request)
IsochronousReadRequest	dequeue ()
unsigned int	dequeue (unsigned int requests, unsigned int microseconds)
bool	wait (unsigned int microseconds)

Constructor & Destructor Documentation

IsochronousReadChannel() [1/3]

IEEE1394Common::IsochronousReadChannel::IsochronousReadChannel ( )

inlinenoexcept

Initialize channel as closed.

IsochronousReadChannel() [2/3]

IEEE1394Common::IsochronousReadChannel::IsochronousReadChannel ( IsochronousReadChannelImpl *  _readChannel )

inline

Initializes read channel.

IsochronousReadChannel() [3/3]

IEEE1394Common::IsochronousReadChannel::IsochronousReadChannel ( const IsochronousReadChannel &  copy )

inlinenoexcept

Initialize channel from other channel.

Member Function Documentation

cancel()

void IEEE1394Common::IsochronousReadChannel::cancel ( )

inline

Cancels all pending requests.

close()

void IEEE1394Common::IsochronousReadChannel::close ( )

inline

Closes the channel.

dequeue() [1/2]

IsochronousReadRequest IEEE1394Common::IsochronousReadChannel::dequeue ( )

inline

Returns the next completed request.

Returns

NOT_A_REQUEST if no request is available in the completion queue.

dequeue() [2/2]

unsigned int IEEE1394Common::IsochronousReadChannel::dequeue ( unsigned int  requests, unsigned int  microseconds  )

inline

Dequeues the specified number of requests.

Parameters

request	The number of request to dequeue.
microseconds	The timeout period in microseconds [0; 999999999].

Returns

The number of dequeued requests.

getReadFixedDataRequest()

IsochronousReadFixedDataRequest IEEE1394Common::IsochronousReadChannel::getReadFixedDataRequest ( ) const

inlinenoexcept

Returns a read fixed data request object (READ_FIXED_DATA_REQUEST).

getReadFixedPacketsRequest()

IsochronousReadFixedPacketsRequest IEEE1394Common::IsochronousReadChannel::getReadFixedPacketsRequest ( ) const

inlinenoexcept

Returns a read fixed packet request object (READ_FIXED_PACKETS_REQUEST).

getReadPacketsRequest()

IsochronousReadPacketsRequest IEEE1394Common::IsochronousReadChannel::getReadPacketsRequest ( ) const

inlinenoexcept

Returns a read packet request object (READ_PACKETS_REQUEST).

getSubchannels()

uint64 IEEE1394Common::IsochronousReadChannel::getSubchannels ( )

inline

Returns the reserved subchannels.

operator=()

IsochronousReadChannel& IEEE1394Common::IsochronousReadChannel::operator= ( const IsochronousReadChannel &  assign )

inlinenoexcept

Assignment of channel by channel.

queue() [1/5]

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

inline

Queues the specified read requests.

queue() [2/5]

void IEEE1394Common::IsochronousReadChannel::queue ( IsochronousReadFixedDataRequest &  request )

inline

Queues the specified read request.

queue() [3/5]

void IEEE1394Common::IsochronousReadChannel::queue ( IsochronousReadFixedPacketsRequest &  request )

inline

Queues the specified read request.

queue() [4/5]

void IEEE1394Common::IsochronousReadChannel::queue ( IsochronousReadPacketsRequest &  request )

inline

Queues the specified read request.

queue() [5/5]

void IEEE1394Common::IsochronousReadChannel::queue ( IsochronousReadRequest &  request )

inline

Queues the specified read request.

wait()

bool IEEE1394Common::IsochronousReadChannel::wait ( unsigned int  microseconds )

inline

Wait for an event.

Parameters

microseconds

The timeout period in microseconds [0; 999999999].

Returns

True if event occured within the specified timeout period and otherwise false.