HSS1394  Release1.00
Public Member Functions | Static Public Member Functions | Static Protected Attributes | List of all members
hss1394::Node Class Referenceabstract

Singleton High-speed serial over 1394 host node interface. More...

#include <HSS1394.h>

Public Member Functions

virtual void InstallConnectionListener (Listener *pListener)=0
 
virtual uint GetNodeCount (void)=0
 Return the number of HSS1394 nodes available to connect to.
 
virtual bool GetNodeInfo (TNodeInfo &tNodeInfo, uint uNode, bool *pbAvailable=NULL, bool *pbInstalled=NULL)=0
 
virtual ChannelOpenChannel (uint uNode)=0
 
virtual bool ReleaseChannel (Channel *pChannel)=0
 

Static Public Member Functions

static NodeInstance (void)
 
static void Shutdown (void)
 Shutdown the current instance - cleanup.
 

Static Protected Attributes

static NodemspInstance
 Singleton instance of class.
 

Detailed Description

Singleton High-speed serial over 1394 host node interface.

Member Function Documentation

◆ GetNodeInfo()

virtual bool hss1394::Node::GetNodeInfo ( TNodeInfo tNodeInfo,
uint  uNode,
bool *  pbAvailable = NULL,
bool *  pbInstalled = NULL 
)
pure virtual

Return information about the specified node. if pbAvailable is not NULL, on return *pbAvailable==TRUE implies that a channel may be opened with this node. Note that exclusivity requires a maximum of one channel is open with any network node at any time. If pbInstalled is not NULL, on return, the *pbInstalled variable will be set if sufficient driver resources are configured to allow normal operation with this node. This being set to false may indicate the need to complete installation of drivers for this node.

◆ InstallConnectionListener()

virtual void hss1394::Node::InstallConnectionListener ( Listener pListener)
pure virtual

Add a user-defined connection listener callback object. This object's ::Do method will be invoked whenever the topology of the HSS1394 network changes. Note that this will not occur on every 1394 bus reset. Note that this call may occur from a separate thread. The user must deal with any concurrency control issues.

◆ Instance()

static Node* hss1394::Node::Instance ( void  )
static

Return a pointer to the signeton 1394 host-node interface. On the first call this will result in class initialization.

◆ OpenChannel()

virtual Channel* hss1394::Node::OpenChannel ( uint  uNode)
pure virtual

Open the specified channel index, returning a valid channel object or NULL on failure.

◆ ReleaseChannel()

virtual bool hss1394::Node::ReleaseChannel ( Channel pChannel)
pure virtual

Release the specified Channel object. This closes the channel, permitting it to be re-opened in future (if the connection is still available). On failure, returns FALSE.


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