diff -r 89d6a7a84779 -r 25a17d01db0c Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_thread_server.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_thread_server.html Fri Jan 22 18:26:19 2010 +0000 @@ -0,0 +1,426 @@ + + +TB10.1 Example Applications: CThreadServer Class Reference + + + + +

CThreadServer Class Reference

+

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Types

enum  TDriverState {
+  EStateUnknown, +EDriverLoaded, +ELogicalChannelOpened, +ESendingData, +
+  ELogicalChannelClosed, +EDriverUnloaded +
+ }

Public Member Functions

 ~CThreadServer ()
CSession2 * NewSessionL (const TVersion &aVersion, const RMessage2 &aMessage) const
void IncrementRefCount ()
void DecrementRefCount ()
TInt LoadDevice ()
TInt UnloadDevice ()
TInt OpenLogicalChannel ()
void CloseLogicalChannel ()
TInt SendDataToDevice (TRequestStatus &aStatus, const TDesC8 &aData)
void CancelSendData ()
void UpdateDriverState (TDriverState aState)

Static Public Member Functions

static IMPORT_C TInt StartThread (TAny *aPointer)
static void NewLC ()
+

Detailed Description

+Server interface for thread server. +

Definition at line 31 of file threadserver.h.

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum CThreadServer::TDriverState
+
+
+ +

+Enumeration of the driver states.

Enumerator:
+ + + + + + + +
EStateUnknown  +
EDriverLoaded  +
ELogicalChannelOpened  +
ESendingData  +
ELogicalChannelClosed  +
EDriverUnloaded  +
+
+ +

Definition at line 37 of file threadserver.h.

+ +
+

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
CThreadServer::~CThreadServer (  ) 
+
+
+ +

+Destructor. The device driver will be unloaded when the server destructor is called.

+Destructor +

Definition at line 50 of file threadserver.cpp.

+ +
+

+

Member Function Documentation

+ +
+
+ + + + + + + + + +
EXPORT_C TInt CThreadServer::StartThread (TAny *  aPointer  )  [static]
+
+
+ +

+Thread entry function.

+Thread entry-point function. The ThreadServerStart object is passed as the thread parameter +

Definition at line 24 of file threadserverstart.cpp.

+ +
+

+ +

+
+ + + + + + + + +
void CThreadServer::NewLC (  )  [static]
+
+
+ +

+First and second phase constructor.

+Starts two phase construction +

Definition at line 27 of file threadserver.cpp.

+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
CSession2 * CThreadServer::NewSessionL (const TVersion &  aVersion,
const RMessage2 &  aMessage 
) const
+
+
+ +

+Create a server-side session object.

See also:
CServer2::NewSessionL().
+Create a new server-side session
Parameters:
+ + + +
aVersion Version argument
aMessage The message to process
+
+
Returns:
Instance of server side client session.
+ +

Definition at line 66 of file threadserver.cpp.

+ +
+

+ +

+
+ + + + + + + + +
void CThreadServer::IncrementRefCount (  ) 
+
+
+ +

+Increase reference count and cancel shutdown timer. This function is called when a new session is created.

+Increment the count of the number of clients connected +

Definition at line 81 of file threadserver.cpp.

+ +
+

+ +

+
+ + + + + + + + +
void CThreadServer::DecrementRefCount (  ) 
+
+
+ +

+Decrease reference count and start shutdown timer. This function is called when a session is destroyed.

+Decrement the count of the number of clients connected +

Definition at line 89 of file threadserver.cpp.

+ +
+

+ +

+
+ + + + + + + + +
TInt CThreadServer::LoadDevice (  ) 
+
+
+ +

+Load device, including sample PDD and LDD.

+Load both LDD and PDD

Returns:
KErrNone or standard error code.
+ +

Definition at line 117 of file threadserver.cpp.

+ +
+

+ +

+
+ + + + + + + + +
TInt CThreadServer::UnloadDevice (  ) 
+
+
+ +

+Unload device, including sample LDD and PDD.

+Unload both LDD and PDD

Returns:
KErrNone or standard error code.
+ +

Definition at line 138 of file threadserver.cpp.

+ +
+

+ +

+
+ + + + + + + + +
TInt CThreadServer::OpenLogicalChannel (  ) 
+
+
+ +

+Open device logical channel.

+Open LDD

Returns:
KErrNone or standard error code.
+ +

Definition at line 164 of file threadserver.cpp.

+ +
+

+ +

+
+ + + + + + + + +
void CThreadServer::CloseLogicalChannel (  ) 
+
+
+ +

+Close device logical channel.

+Close LDD +

Definition at line 178 of file threadserver.cpp.

+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
TInt CThreadServer::SendDataToDevice (TRequestStatus &  aStatus,
const TDesC8 &  aData 
)
+
+
+ +

+Send data to device. It is an asynchronous request.

+Send data to LDD device

Parameters:
+ + + +
aStatus 
aData Data to be sent
+
+
Returns:
KErrNone or standard error code.
+ +

Definition at line 192 of file threadserver.cpp.

+ +
+

+ +

+
+ + + + + + + + +
void CThreadServer::CancelSendData (  ) 
+
+
+ +

+Cancel send data operation to device driver.

+Cancel sending data +

Definition at line 209 of file threadserver.cpp.

+ +
+

+ +

+
+ + + + + + + + + +
void CThreadServer::UpdateDriverState (TDriverState  aState  ) 
+
+
+ +

+Update device state.

+Update the states of the driver

Parameters:
+ + +
aState State of the driver to be updated
+
+ +

Definition at line 218 of file threadserver.cpp.

+ +
+

+

Generated on Thu Jan 21 10:33:07 2010 for TB10.1 Example Applications by  + +doxygen 1.5.3
+ +