Collapse all Symbian^3 Product Developer Library

RBusDevEthernet Class Reference

class RBusDevEthernet : public RBusLogicalChannel

The externally visible interface

Inherits from

RBusDevEthernet
- RBusLogicalChannel
  - RHandleBase

Public Member Functions
void	Caps(TDes8 &)
void	Config(TDes8 &)
TInt	Open(TInt)
void	Read(TRequestStatus &, TDes8 &)
void	Read(TRequestStatus &, TDes8 &, TInt)
void	ReadCancel()
TInt	SetConfig(const TDesC8 &)
TInt	SetMAC(const TDesC8 &)
TVersion	VersionRequired()
void	Write(TRequestStatus &, const TDesC8 &)
void	Write(TRequestStatus &, const TDesC8 &, TInt)
void	WriteCancel()

Inherited Functions
	RBusLogicalChannel::DoCancel(TUint)
	RBusLogicalChannel::DoControl(TInt)
	RBusLogicalChannel::DoControl(TInt,TAny *)
	RBusLogicalChannel::DoControl(TInt,TAny ,TAny )
	RBusLogicalChannel::DoCreate(const TDesC &,const TVersion &,TInt,const TDesC ,const TDesC8 ,TOwnerType,TBool)
	RBusLogicalChannel::DoRequest(TInt,TRequestStatus &)
	RBusLogicalChannel::DoRequest(TInt,TRequestStatus &,TAny *)
	RBusLogicalChannel::DoRequest(TInt,TRequestStatus &,TAny ,TAny )
	RBusLogicalChannel::DoSvControl(TInt)
	RBusLogicalChannel::DoSvControl(TInt,TAny *)
	RBusLogicalChannel::DoSvControl(TInt,TAny ,TAny )
	RBusLogicalChannel::Open(RMessagePtr2,TInt,TOwnerType)
	RBusLogicalChannel::Open(TInt,TOwnerType)
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	RHandleBase::Close()
	RHandleBase::DoExtendedClose()
	RHandleBase::Duplicate(const RThread &,TOwnerType)
	RHandleBase::FullName()const
	RHandleBase::FullName(TDes &)const
	RHandleBase::Handle()const
	RHandleBase::HandleInfo(THandleInfo *)
	RHandleBase::Name()const
	RHandleBase::NotifyDestruction(TRequestStatus &)
	RHandleBase::Open(const TFindHandleBase &,TOwnerType)
	RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
	RHandleBase::RHandleBase()
	RHandleBase::RHandleBase(TInt)
	RHandleBase::SetHandle(TInt)
	RHandleBase::SetHandleNC(TInt)
	RHandleBase::SetReturnedHandle(TInt)
	RHandleBase::SetReturnedHandle(TInt,RHandleBase &)

Public Member Enumerations
enum	TControl { EControlConfig, EControlSetConfig, EControlSetMac, EControlCaps }
enum	TRequest { ERequestRead = 0x0, ERequestReadCancel = 0x1, ERequestWrite = 0x1, ERequestWriteCancel = 0x2 }
enum	TVer { EMajorVersionNumber = 1, EMinorVersionNumber = 0, EBuildVersionNumber = KE32BuildVersionNumber }

Inherited Enumerations
	RHandleBase:TAttributes

Inherited Attributes
	RHandleBase::iHandle

Member Functions Documentation

Caps(TDes8 &)

void

Caps

(

TDes8 &

aCaps

)

[inline]

Request the channels capabilities

Parameters

TDes8 & aCaps

Buffer to contain the capibilites object

Config(TDes8 &)

void

Config

(

TDes8 &

aConfig

)

[inline]

Get the channels configuration

Parameters

TDes8 & aConfig

Buffer that will contain an configuration object

Open(TInt)

TInt

Open

(

TInt

aUnit

)

[inline]

Open a channel

capability: CommDD

Parameters

TInt aUnit

The channel number to open

Read(TRequestStatus &, TDes8 &)

void	Read	(	TRequestStatus &	aStatus,
			TDes8 &	aDes
		)	[inline]

Read from the channel

Parameters

TRequestStatus & aStatus	The callback status
TDes8 & aDes	Buffer to be filled in

Read(TRequestStatus &, TDes8 &, TInt)

void	Read	(	TRequestStatus &	aStatus,
			TDes8 &	aDes,
			TInt	aLength
		)	[inline]

Read from the channel

Parameters

TRequestStatus & aStatus	The callback status
TDes8 & aDes	Buffer to be filled in
TInt aLength	The maximun length frame to read

ReadCancel()

void

ReadCancel

(

)

[inline]

Cancel a pending read request

SetConfig(const TDesC8 &)

TInt

SetConfig

(

const TDesC8 &

aConfig

)

[inline]

Set the channels configuration

Parameters

const TDesC8 & aConfig

Buffer containing an configuration object

SetMAC(const TDesC8 &)

TInt

SetMAC

(

const TDesC8 &

aConfig

)

[inline]

Set the channels MAC address

Parameters

const TDesC8 & aConfig

Buffer containing an configuration object with the MAC address set

VersionRequired()

TVersion

VersionRequired

(

)

const [inline]

Get the ethernet version

Write(TRequestStatus &, const TDesC8 &)

void	Write	(	TRequestStatus &	aStatus,
			const TDesC8 &	aDes
		)	[inline]

Write to the channel

Parameters

TRequestStatus & aStatus	The callback status
const TDesC8 & aDes	Buffer containing the frame to be sent

Write(TRequestStatus &, const TDesC8 &, TInt)

void	Write	(	TRequestStatus &	aStatus,
			const TDesC8 &	aDes,
			TInt	aLength
		)	[inline]

Write to the channel

Parameters

TRequestStatus & aStatus	The callback status
const TDesC8 & aDes	Buffer containing the frame to be sent
TInt aLength	The length of the frame to send

WriteCancel()

void

WriteCancel

(

)

[inline]

Cancel a pending write request

Member Enumerations Documentation

Enum TControl

Control requests

Enumerators

EControlConfig	Get the current configuration
EControlSetConfig	Set the current configuration
EControlSetMac	Set the MAC address
EControlCaps	Get ethernet capibilites

Enum TRequest

Asyncorus requests

Enumerators

ERequestRead = 0x0	Read request
ERequestReadCancel = 0x1	Cancel read request
ERequestWrite = 0x1	Write request
ERequestWriteCancel = 0x2	Cancel write request

Enum TVer

Enumerators

EMajorVersionNumber = 1
EMinorVersionNumber = 0
EBuildVersionNumber = KE32BuildVersionNumber