hss1394::Channel Class Reference

#include <HSS1394.h>

Public Member Functions
virtual void	Stop (void)=0
virtual void	Restart (void)=0
	Re-start data transmission/reception.
virtual void	Flush (void)=0
	Cause send and receive data buffers to be flushed.
virtual void	GetNodeInfo (TNodeInfo &tNodeInfo)=0
virtual uint	SendChannelBytes (const uint8 *pBuffer, uint uBufferSize, bool bForce=true)=0
virtual uint	SendChannelEcho (const uint8 *pBuffer, uint uBufferSize)=0
virtual uint	GetRetries (void)=0
virtual uint	ReceiveChannelBytes (uint8 *pBuffer, uint uBufferSize)=0
virtual bool	InstallChannelListener (ChannelListener *pListener)=0
virtual bool	ChannelListenerExists (void)=0
virtual uint	SendUserControl (uint8 uUserTag, const uint8 *pUserData, uint uDataBytes)=0

Detailed Description

Abstraction of a channel endpoint at the host communicating with a remote HSS1394 node.

Member Function Documentation

ChannelListenerExists()

virtual bool hss1394::Channel::ChannelListenerExists ( void  )

pure virtual

Returns TRUE if there is a channel listener installed on this channel, false otherwise.

GetNodeInfo()

virtual void hss1394::Channel::GetNodeInfo ( TNodeInfo &  tNodeInfo )

pure virtual

Return an information structure describing the node connected via this channel.

GetRetries()

virtual uint hss1394::Channel::GetRetries ( void  )

pure virtual

Return the number of send retries that have occurred since the last call to ::GetRetries or since the channel was created.

InstallChannelListener()

virtual bool hss1394::Channel::InstallChannelListener ( ChannelListener *  pListener )

pure virtual

Install (or uninstall) a channel listener object onto the receive channel. If the argument is NULL, then the existing listener (if any) will be removed. Storage management of the listener object remains the responsibility of the caller. On the initial call, any data in the buffer will be immediately passed to the just-installed listener, flushing the receive buffer.

ReceiveChannelBytes()

virtual uint hss1394::Channel::ReceiveChannelBytes ( uint8 *  pBuffer, uint  uBufferSize  )

pure virtual

Receive up to the specified number of bytes into pBuffer from the channel. Returns the number of bytes received. If a channel listener is installed, will always return zero.

SendChannelBytes()

virtual uint hss1394::Channel::SendChannelBytes ( const uint8 *  pBuffer, uint  uBufferSize, bool  bForce = true  )

pure virtual

Send the specified buffer of the specified length. On success returns the number of bytes actually sent. This may be less than uBufferSize and specifies the size of the prefix within pBuffer which has been sent.

SendChannelEcho()

virtual uint hss1394::Channel::SendChannelEcho ( const uint8 *  pBuffer, uint  uBufferSize  )

pure virtual

Send a packet to be echoed back (testing purposes). Packet will not be passed to application layer on receiving node.

SendUserControl()

virtual uint hss1394::Channel::SendUserControl ( uint8  uUserTag, const uint8 *  pUserData, uint  uDataBytes  )

pure virtual

Send a user control message via the channel to the target node. Returns the number of bytes sent on success, zero on failure. uUserTag is valid in the range 0x00 - 0xDF. All other tag values will be rejected (0 return).

Stop()

virtual void hss1394::Channel::Stop ( void  )

pure virtual

Stop data transmission/reception. After this call all send and receive calls will fail with a zero return.

---

The documentation for this class was generated from the following file:

• /home/runner/work/hss1394/hss1394/include/HSS1394.h