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

Isochronous read packets request. More...

#include <base/communication/IEEE1394Common.h>

Inherits Object.

Public Member Functions

 IsochronousReadPacketsRequest (IsochronousReadPacketsRequestImpl *_context) noexcept
 
 IsochronousReadPacketsRequest (const IsochronousReadPacketsRequest &copy) noexcept
 
IsochronousReadPacketsRequestoperator= (const IsochronousReadPacketsRequest &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
 
uint8 * getBuffer () const noexcept
 
void setBuffer (uint8 *buffer, unsigned int size)
 

Detailed Description

Isochronous read packets request.

Isochronous read packets request (READ_PACKETS_REQUEST).

Version
1.0

Constructor & Destructor Documentation

◆ IsochronousReadPacketsRequest() [1/2]

IEEE1394Common::IsochronousReadPacketsRequest::IsochronousReadPacketsRequest ( IsochronousReadPacketsRequestImpl _context)
inlinenoexcept

Initializes object.

◆ IsochronousReadPacketsRequest() [2/2]

IEEE1394Common::IsochronousReadPacketsRequest::IsochronousReadPacketsRequest ( const IsochronousReadPacketsRequest copy)
inlinenoexcept

Initializes object from other object.

Member Function Documentation

◆ getBuffer()

uint8* IEEE1394Common::IsochronousReadPacketsRequest::getBuffer ( ) const
inlinenoexcept

Returns the buffer.

◆ getBufferSize()

unsigned int IEEE1394Common::IsochronousReadPacketsRequest::getBufferSize ( ) const
inlinenoexcept

Returns the size of the buffer.

◆ getOptions()

unsigned int IEEE1394Common::IsochronousReadPacketsRequest::getOptions ( ) const
inlinenoexcept

Returns the options of the request.

◆ getReceivedPackets()

unsigned int IEEE1394Common::IsochronousReadPacketsRequest::getReceivedPackets ( ) const
inlinenoexcept

Returns the number of received packets.

◆ getStatus()

IsochronousRequestStatus IEEE1394Common::IsochronousReadPacketsRequest::getStatus ( ) const
inlinenoexcept

Returns the current status of the request.

◆ getSubchannel()

unsigned int IEEE1394Common::IsochronousReadPacketsRequest::getSubchannel ( )
inlinenoexcept

Returns the subchannel.

◆ isPending()

bool IEEE1394Common::IsochronousReadPacketsRequest::isPending ( ) const
inlinenoexcept

Returns true if the request is pending for completion.

◆ isValid()

bool IEEE1394Common::IsochronousReadPacketsRequest::isValid ( ) const
inlinenoexcept

Returns true if request is valid.

◆ operator=()

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

Assignment of object by object.

◆ reset()

void IEEE1394Common::IsochronousReadPacketsRequest::reset ( )
inline

Resets the request. Raises IEEE1394Exception is request is pending.

◆ setBuffer()

void IEEE1394Common::IsochronousReadPacketsRequest::setBuffer ( uint8 *  buffer,
unsigned int  size 
)
inline

Sets the buffer.

Parameters
bufferThe location of the buffer.
sizeThe size of the buffer in bytes.

◆ setSubchannel()

void IEEE1394Common::IsochronousReadPacketsRequest::setSubchannel ( unsigned int  subchannel)
inline

Sets the subchannel.