Symbian^3 Application Developer Library >

RUsbPipe Class Reference

class RUsbPipe

Functions which act on an individual pipe established between the local host and a remote device.

Public Member Functions
RUsbPipe ()
void CancelAllTransfers ()
TInt ClearRemoteStall ()
void Close ()
TInt GetBusId ( TUsbBusId &)
TInt GetEndpointDescriptor ( TUsbEndpointDescriptor &)
TInt GetEndpointId ( TUsbEndpointId &)
TUint32 Handle ()
IMPORT_C void Transfer ( RUsbTransferDescriptor &, TRequestStatus &)
Private Member Functions
void IssueTransfer ( TInt , TRequestStatus &)
Public Member Enumerations
enum TUsbPipeControl { EClose  = 0x4000000, EAbort , EClearRemoteStall , EGetEndpointId }
enum TUsbPipeRequest { EIssueTransfer  = 0x4000000 }
Private Attributes
TUint32 iHandle
TUsbEndpointDescriptor * iHeadEndpointDescriptor
RUsbInterface * iInterface

Constructor & Destructor Documentation

RUsbPipe()

RUsbPipe ( ) [inline]

Member Functions Documentation

CancelAllTransfers()

void CancelAllTransfers ( ) [inline]

Cancel all queued transfers

ClearRemoteStall()

TInt ClearRemoteStall ( ) [inline]

Clear a stall on the remote endpoint.

Close()

void Close ( ) [inline]

Close a pipe to a remote device.

GetBusId(TUsbBusId &)

TInt GetBusId ( TUsbBusId & aBusId ) [inline]

Get Bus ID

Parameters

TUsbBusId & aBusId

GetEndpointDescriptor(TUsbEndpointDescriptor &)

TInt GetEndpointDescriptor ( TUsbEndpointDescriptor & aDescriptor ) [inline]

Return the section of the USB Configuration Descriptor under the supplied endpoint.

Parameters

TUsbEndpointDescriptor & aDescriptor The descriptor tree for this endpoint.

GetEndpointId(TUsbEndpointId &)

TInt GetEndpointId ( TUsbEndpointId & aEndpointId ) [inline]

Get endpoint ID

Parameters

TUsbEndpointId & aEndpointId

Handle()

TUint32 Handle ( ) const [inline]

IssueTransfer(TInt, TRequestStatus &)

void IssueTransfer ( TInt aTransferHandle,
TRequestStatus & aRequest
) [private, inline]

Issues a transfer.

Parameters

TInt aTransferHandle
TRequestStatus & aRequest

Transfer(RUsbTransferDescriptor &, TRequestStatus &)

IMPORT_C void Transfer ( RUsbTransferDescriptor & aTransfer,
TRequestStatus & aRequest
)

Queue a transfer.

Parameters

RUsbTransferDescriptor & aTransfer The transfer descriptor to execute.
TRequestStatus & aRequest Holds completion status of the transfer.

Member Enumerations Documentation

Enum TUsbPipeControl

Enumerators

EClose = 0x4000000
EAbort
EClearRemoteStall
EGetEndpointId

Enum TUsbPipeRequest

Enumerators

EIssueTransfer = 0x4000000

Member Data Documentation

TUint32 iHandle

TUint32 iHandle [private]

TUsbEndpointDescriptor * iHeadEndpointDescriptor

TUsbEndpointDescriptor * iHeadEndpointDescriptor [private]

RUsbInterface * iInterface

RUsbInterface * iInterface [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.