IEEE1394Common::IsochronousReadFixedDataRequest Class Reference

Isochronous read fixed data request. More...

#include <base/communication/IEEE1394Common.h>

Inherits Object.

Public Member Functions
	IsochronousReadFixedDataRequest () noexcept
	IsochronousReadFixedDataRequest (IsochronousReadFixedDataRequestImpl *_context) noexcept
	IsochronousReadFixedDataRequest (const IsochronousReadFixedDataRequest &copy) noexcept
IsochronousReadFixedDataRequest &	operator= (const IsochronousReadFixedDataRequest &assign) noexcept
bool	isValid () const noexcept
bool	isPending () const noexcept
IsochronousRequestStatus	getStatus () const noexcept
void	reset ()
unsigned int	getOptions () const noexcept
unsigned int	getBufferSize () const noexcept
unsigned int	getSubchannel () noexcept
void	setSubchannel (unsigned int subchannel)
unsigned int	getReceivedPackets () const noexcept
unsigned int	getNumberOfPackets () const noexcept
void	setNumberOfPackets (unsigned int packets)
unsigned int	getHeaderSize () const noexcept
void	setHeaderSize (unsigned int size)
unsigned int	getPayload () const noexcept
void	setPayload (unsigned int payload)
uint8 *	getBuffer () const noexcept
uint8 *	getSecondaryBuffer () const noexcept
void	setBuffer (uint8 *buffer, unsigned int size, uint8 *secondaryBuffer)

Detailed Description

Isochronous read fixed data request.

Isochronous read fixed data request (READ_FIXED_DATA_REQUEST).

Version

1.0

Constructor & Destructor Documentation

IsochronousReadFixedDataRequest() [1/3]

IEEE1394Common::IsochronousReadFixedDataRequest::IsochronousReadFixedDataRequest ( )

inlinenoexcept

Initializes invalid request.

IsochronousReadFixedDataRequest() [2/3]

IEEE1394Common::IsochronousReadFixedDataRequest::IsochronousReadFixedDataRequest ( IsochronousReadFixedDataRequestImpl *  _context )

inlinenoexcept

Initializes object.

IsochronousReadFixedDataRequest() [3/3]

IEEE1394Common::IsochronousReadFixedDataRequest::IsochronousReadFixedDataRequest ( const IsochronousReadFixedDataRequest &  copy )

inlinenoexcept

Initializes object from other object.

Member Function Documentation

getBuffer()

uint8* IEEE1394Common::IsochronousReadFixedDataRequest::getBuffer ( ) const

inlinenoexcept

Returns the buffer.

getBufferSize()

unsigned int IEEE1394Common::IsochronousReadFixedDataRequest::getBufferSize ( ) const

inlinenoexcept

Returns the size of the buffer.

getHeaderSize()

unsigned int IEEE1394Common::IsochronousReadFixedDataRequest::getHeaderSize ( ) const

inlinenoexcept

Returns the size of the header in bytes per packet.

getNumberOfPackets()

unsigned int IEEE1394Common::IsochronousReadFixedDataRequest::getNumberOfPackets ( ) const

inlinenoexcept

Returns the desired number of packets to be received.

getOptions()

unsigned int IEEE1394Common::IsochronousReadFixedDataRequest::getOptions ( ) const

inlinenoexcept

Returns the options of the request.

getPayload()

unsigned int IEEE1394Common::IsochronousReadFixedDataRequest::getPayload ( ) const

inlinenoexcept

Returns the maximum payload in bytes per packet.

getReceivedPackets()

unsigned int IEEE1394Common::IsochronousReadFixedDataRequest::getReceivedPackets ( ) const

inlinenoexcept

Returns the number of received packets.

getSecondaryBuffer()

uint8* IEEE1394Common::IsochronousReadFixedDataRequest::getSecondaryBuffer ( ) const

inlinenoexcept

Returns the secondary buffer used for header data.

getStatus()

IsochronousRequestStatus IEEE1394Common::IsochronousReadFixedDataRequest::getStatus ( ) const

inlinenoexcept

Returns the current status of the request.

getSubchannel()

unsigned int IEEE1394Common::IsochronousReadFixedDataRequest::getSubchannel ( )

inlinenoexcept

Returns the subchannel.

isPending()

bool IEEE1394Common::IsochronousReadFixedDataRequest::isPending ( ) const

inlinenoexcept

Returns true if the request is pending for completion.

isValid()

bool IEEE1394Common::IsochronousReadFixedDataRequest::isValid ( ) const

inlinenoexcept

Returns true if request is valid.

operator=()

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

inlinenoexcept

Assignment of object by object.

reset()

void IEEE1394Common::IsochronousReadFixedDataRequest::reset ( )

inline

Resets the request. Raises IEEE1394Exception is request is pending.

setBuffer()

void IEEE1394Common::IsochronousReadFixedDataRequest::setBuffer ( uint8 *  buffer, unsigned int  size, uint8 *  secondaryBuffer  )

inline

Sets the buffer.

Parameters

buffer	The location of the buffer.
size	The size of the buffer in bytes.
secondaryBuffer	The secondary buffer.

setHeaderSize()

void IEEE1394Common::IsochronousReadFixedDataRequest::setHeaderSize ( unsigned int  size )

inline

Sets the size of the header in bytes per packet (the size must be an integral number of 32 bit words).

setNumberOfPackets()

void IEEE1394Common::IsochronousReadFixedDataRequest::setNumberOfPackets ( unsigned int  packets )

inline

Sets the desired number of packets to be received.

setPayload()

void IEEE1394Common::IsochronousReadFixedDataRequest::setPayload ( unsigned int  payload )

inline

Sets the payload in bytes per packet (the size must be an integral number of 32 bit words).

setSubchannel()

void IEEE1394Common::IsochronousReadFixedDataRequest::setSubchannel ( unsigned int  subchannel )

inline

Sets the subchannel.