Collapse all Symbian^3 Application Developer Library

RAcmServer Class Reference

class RAcmServer

Client interface to the ACM server to create new ACM functions. This class is intended to be used both inside and outside Symbian to bring up and tear down ACM functions.

Public Member Functions
	RAcmServer ()
	~RAcmServer ()
IMPORT_C void	Close ()
IMPORT_C TInt	Connect ()
IMPORT_C TInt	CreateFunctions (const TUint )
IMPORT_C TInt	CreateFunctions (const TUint , const TUint8 )
IMPORT_C TInt	CreateFunctions (const TUint , const TUint8 , const TDesC &, const TDesC &)
IMPORT_C TInt	DestroyFunctions (const TUint )

Private Member Functions
	RAcmServer (const RAcmServer &)

Private Attributes
CAcmServerImpl *	iImpl

Constructor & Destructor Documentation

RAcmServer()

IMPORT_C

RAcmServer

(

)

Standard constructor. Does not connect the handle to the service provider.

RAcmServer(const RAcmServer &)

RAcmServer

(

const RAcmServer &

aObjectToCopy

)

[private]

Private copy constructor to avoid problems with multiple ownership of RAcmServerImpls.

Parameters

const RAcmServer & aObjectToCopy

~RAcmServer()

IMPORT_C

~RAcmServer

(

)

Standard destructor. Does not disconnect the handle from the service provider.

Member Functions Documentation

Close()

IMPORT_C void

(

)

Closes this handle to the service provider. If the handle has been successfully Connected, it must eventually be Closed.

Connect()

IMPORT_C TInt

Connect

(

)

Connects this handle to the service provider.

CreateFunctions(const TUint)

IMPORT_C TInt

CreateFunctions

(

const TUint

aNoAcms

)

Creates aNoAcms ACM functions using the default settings. The default setting includes KDefaultAcmProtocolNum- protocol code 0x01 (Hayes compatible, from USBCDC 1.1 Table 17).

Parameters

const TUint aNoAcms

Number of ACM functions to be created.

CreateFunctions(const TUint, const TUint8)

IMPORT_C TInt	CreateFunctions	(	const TUint	aNoAcms,
			const TUint8	aProtocolNum
		)

Creates aNoAcms ACM functions using the protocol number given (as defined in USBCDC 1.1 - Table 17).

Parameters

const TUint aNoAcms	Number of ACM functions to be created.
const TUint8 aProtocolNum	Protocol setting for the ACM functions to be created.

CreateFunctions(const TUint, const TUint8, const TDesC &, const TDesC &)

IMPORT_C TInt	CreateFunctions	(	const TUint	aNoAcms,
			const TUint8	aProtocolNum,
			const TDesC &	aAcmControlIfcName,
			const TDesC &	aAcmDataIfcName
		)

Creates aNoAcms ACM functions using the protocol number given (as defined in USBCDC 1.1 - Table 17).

Parameters

const TUint aNoAcms	Number of ACM functions to be created.
const TUint8 aProtocolNum	Protocol setting for the ACM function to be created.
const TDesC & aAcmControlIfcName	Control Interface Name for the ACM function to be created.
const TDesC & aAcmDataIfcName	Data Interface Name for the ACM function to be created.

DestroyFunctions(const TUint)

IMPORT_C TInt

DestroyFunctions

(

const TUint

aNoAcms

)

Destroys aNoAcms ACM functions. Class Controllers MUST NOT destroy more ACM functions than they have successfully created.

Parameters

const TUint aNoAcms

Number of ACM interfaces to destroy.

Member Data Documentation

CAcmServerImpl * iImpl

CAcmServerImpl *

iImpl

[private]