fusb_ephandle Class Reference

#include <fusb.h>

Inheritance diagram for fusb_ephandle:

[legend]List of all members.

---

Detailed Description

abstract usb end point handle

Public Member Functions
	fusb_ephandle (int endpoint, bool input_p, int block_size=0, int nblocks=0)
virtual	~fusb_ephandle ()
virtual bool	start ()=0
	begin streaming i/o
virtual bool	stop ()=0
	stop streaming i/o
virtual int	write (const void *buffer, int nbytes)=0
virtual int	read (void *buffer, int nbytes)=0
virtual void	wait_for_completion ()=0
int	block_size ()
	returns current block size.
Protected Attributes
int	d_endpoint
bool	d_input_p
int	d_block_size
int	d_nblocks
bool	d_started

---

Constructor & Destructor Documentation

fusb_ephandle::fusb_ephandle (  int  endpoint, bool  input_p, int  block_size = 0, int  nblocks = 0 )

fusb_ephandle::~fusb_ephandle (   )  [virtual]

---

Member Function Documentation

int fusb_ephandle::block_size (   )  [inline]

returns current block size.

virtual int fusb_ephandle::read (  void *  buffer, int  nbytes )  [pure virtual]

Returns: number of bytes read or -1 if error. number of bytes read will be <= nbytes. Will block if no input available. Implemented in fusb_ephandle_darwin, fusb_ephandle_generic, fusb_ephandle_linux, fusb_ephandle_ra_wb, and fusb_ephandle_win32.

virtual bool fusb_ephandle::start (   )  [pure virtual]

begin streaming i/o Implemented in fusb_ephandle_darwin, fusb_ephandle_generic, fusb_ephandle_linux, fusb_ephandle_ra_wb, and fusb_ephandle_win32.

virtual bool fusb_ephandle::stop (   )  [pure virtual]

stop streaming i/o Implemented in fusb_ephandle_darwin, fusb_ephandle_generic, fusb_ephandle_linux, fusb_ephandle_ra_wb, and fusb_ephandle_win32.

virtual void fusb_ephandle::wait_for_completion (   )  [pure virtual]

Implemented in fusb_ephandle_darwin, fusb_ephandle_generic, fusb_ephandle_linux, fusb_ephandle_ra_wb, and fusb_ephandle_win32.

virtual int fusb_ephandle::write (  const void *  buffer, int  nbytes )  [pure virtual]

Returns: nbytes if write was successfully enqueued, else -1. Will block if no free buffers available. Implemented in fusb_ephandle_darwin, fusb_ephandle_generic, fusb_ephandle_linux, fusb_ephandle_ra_wb, and fusb_ephandle_win32.

---

Member Data Documentation

int fusb_ephandle::d_block_size [protected]

int fusb_ephandle::d_endpoint [protected]

bool fusb_ephandle::d_input_p [protected]

int fusb_ephandle::d_nblocks [protected]

bool fusb_ephandle::d_started [protected]

---

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

• fusb.h
• fusb.cc

---