RUsbOstComm Class Reference

#include <usbostcomm.h>

Inheritance diagram for RUsbOstComm:

Public Functions
TInt	Close ()
TInt	Connect ()
TInt	Disconnect ()
TInt	Open ()
TInt	ReadCancel ()
void	ReadMessage (TRequestStatus &aStatus, TDes8 &aDes)
TInt	RegisterProtocolID (TOstProtIds aId, TBool aNeedHeader)
	RUsbOstComm ()
TVersion	Version () const
void	WriteMessage (TRequestStatus &aStatus, const TDesC8 &aDes, TBool aHasHeader=EFalse)

Private Types
enum	TUsbOstCmdCode {   EUsbOstCmdCodeFirst, EUsbOstCmdConnect, EUsbOstCmdDisconnect, EUsbOstCmdCodeGetAcmConfig,   EUsbOstCmdCodeSetAcmConfig, EUsbOstCmdCodeOpen, EUsbOstCmdCodeClose, EUsbOstCmdCodeRegisterId,   EUsbOstCmdCodeRegisterIds, EUsbOstCmdCodeUnRegisterId, EUsbOstCmdCodeUnRegisterIds, EUsbOstCmdCodeReadMsg,   EUsbOstCmdCodeReadCancel, EUsbOstCmdCodeWriteMsg, EUsbOstCmdCodeWriteCancel, EUsbOstCmdCodeLast }

Detailed Description

Definition at line 52 of file usbostcomm.h.

Enumerations

TUsbOstCmdCode

enum RUsbOstComm::TUsbOstCmdCode

private

Enumerator
EUsbOstCmdCodeFirst
EUsbOstCmdConnect
EUsbOstCmdDisconnect
EUsbOstCmdCodeGetAcmConfig
EUsbOstCmdCodeSetAcmConfig
EUsbOstCmdCodeOpen
EUsbOstCmdCodeClose
EUsbOstCmdCodeRegisterId
EUsbOstCmdCodeRegisterIds
EUsbOstCmdCodeUnRegisterId
EUsbOstCmdCodeUnRegisterIds
EUsbOstCmdCodeReadMsg
EUsbOstCmdCodeReadCancel
EUsbOstCmdCodeWriteMsg
EUsbOstCmdCodeWriteCancel
EUsbOstCmdCodeLast

Definition at line 67 of file usbostcomm.h.

    {
        EUsbOstCmdCodeFirst,
        EUsbOstCmdConnect,
        EUsbOstCmdDisconnect,
        EUsbOstCmdCodeGetAcmConfig,
        EUsbOstCmdCodeSetAcmConfig,
        EUsbOstCmdCodeOpen,
        EUsbOstCmdCodeClose,
        EUsbOstCmdCodeRegisterId,
        EUsbOstCmdCodeRegisterIds,
        EUsbOstCmdCodeUnRegisterId,
        EUsbOstCmdCodeUnRegisterIds,
        EUsbOstCmdCodeReadMsg,
        EUsbOstCmdCodeReadCancel,
        EUsbOstCmdCodeWriteMsg,
        EUsbOstCmdCodeWriteCancel,
        EUsbOstCmdCodeLast
    };

Constructors and Destructors

RUsbOstComm()

RUsbOstComm::RUsbOstComm

(

)

Definition at line 88 of file usbostcomm.h.

{
}

Functions

Close()

TInt RUsbOstComm::Close

(

)

Definition at line 143 of file usbostcomm.h.

{
    TInt err = SendReceive(EUsbOstCmdCodeClose);
    RHandleBase::Close();
    return err;
}

Connect()

TInt RUsbOstComm::Connect

(

)

Definition at line 92 of file usbostcomm.h.

{
    _LIT(KUsbOstServerName, "!UsbOstRouter");
    _LIT(KUsbOstServerImageName, "usbostrouter");
    const TUid KUsbOstServerUid = { 0x200170BE };
    TInt startupAttempts = 2;
    for(;;) {
        TInt ret = CreateSession(KUsbOstServerName, TVersion(1,0,0));
        if (ret != KErrNotFound && ret != KErrServerTerminated) {
            return ret;
        }

        if (startupAttempts-- == 0) {
            return ret;
        }

        RProcess server;
        ret = server.Create(KUsbOstServerImageName, KNullDesC, KUsbOstServerUid);
        if (ret != KErrNone)
            return ret;

        TRequestStatus serverDiedRequestStatus;
        server.Rendezvous(serverDiedRequestStatus);

        if (serverDiedRequestStatus != KRequestPending) {
            // Abort startup
            server.Kill(KErrNone);
        } else {
            // Logon OK - start the server
            server.Resume();
        }
        User::WaitForRequest(serverDiedRequestStatus);
        ret = (server.ExitType() == EExitPanic) ? KErrGeneral : serverDiedRequestStatus.Int();
        server.Close();

        if (ret != KErrNone && ret != KErrAlreadyExists) {
            return ret;
        }
    }
}

Disconnect()

TInt RUsbOstComm::Disconnect

(

)

Definition at line 133 of file usbostcomm.h.

{
    return SendReceive(EUsbOstCmdDisconnect);
}

Open()

TInt RUsbOstComm::Open

(

)

Definition at line 138 of file usbostcomm.h.

{
    return SendReceive(EUsbOstCmdCodeOpen);
}

ReadCancel()

TInt RUsbOstComm::ReadCancel

(

)

Definition at line 162 of file usbostcomm.h.

{
    return SendReceive(EUsbOstCmdCodeReadCancel);
}

ReadMessage()

void RUsbOstComm::ReadMessage	(	TRequestStatus &	aStatus,
		TDes8 &	aDes
	)

Definition at line 156 of file usbostcomm.h.

{
    TIpcArgs args(aDes.MaxLength(), &aDes);
    SendReceive(EUsbOstCmdCodeReadMsg, args, aStatus);
}

RegisterProtocolID()

TInt RUsbOstComm::RegisterProtocolID	(	TOstProtIds	aId,
		TBool	aNeedHeader
	)

Definition at line 150 of file usbostcomm.h.

{
    TIpcArgs args(aId, aNeedHeader);
    return SendReceive(EUsbOstCmdCodeRegisterId, args);
}

Version()

TVersion RUsbOstComm::Version

(

)

const

Definition at line 176 of file usbostcomm.h.

{
    // This function has to go to the DLL, unfortunately
    TVersion result; // Return 0.0.0 on any error
    RLibrary lib;
    TInt err = lib.Load(_L("usbostcomm"));
    if (err) return result;

    TLibraryFunction fn = lib.Lookup(KVersionOrdinal);
    if (fn)
        result = ((TVersionFunction)fn)(this);
    lib.Close();
    return result;
}

WriteMessage()

void RUsbOstComm::WriteMessage	(	TRequestStatus &	aStatus,
		const TDesC8 &	aDes,
		TBool	aHasHeader = EFalse
	)

Definition at line 167 of file usbostcomm.h.

{
    TIpcArgs args(aHasHeader, aDes.Length(), &aDes);
    SendReceive(EUsbOstCmdCodeWriteMsg, args, aStatus);
}

---

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

• /src/plugins/qmltooling/qmldbg_ost/usbostcomm.h