![[Index]](../../../stock/btn_index.gif){kind=small}
![[Glossary]](../../../stock/btn_glossary.gif){kind=small}
![[Previous]](../../../stock/btn_prev.gif){kind=small}
![[Next]](../../../stock/btn_next.gif){kind=small}
| |
|
| |
Location:
etel.h
Link against: etel.lib
RTelServer
Supported from 5.0
Root telephony server session.
Provides access to general telephony information and functionality. Clients wishing to use the ETel Server must open a connection with the root server using the functions defined in this class. They may then obtain information about loaded TSY modules, and the phones that they support. To access functionality associated with a specific phone, the client must open a sub-session for that phone.
This class is not intended for user derivation
|
Defined in RTelServer:
Anonymous, Connect(), EErrorBasic, EErrorExtended, ENetworkTypeMobileAnalog, ENetworkTypeMobileDigital, ENetworkTypeUnknown, ENetworkTypeWiredAnalog, ENetworkTypeWiredDigital, EnumeratePhones(), GetPhoneInfo(), GetTsyName(), GetTsyVersionNumber(), IsSupportedByModule(), KDefaultMessageSlots, LoadPhoneModule(), RTelServer(), SetExtendedErrorGranularity(), SetPriorityClient(), TErrorGranularity, TNetworkType, TPhoneInfo, UnloadPhoneModule(), Version()
Inherited from RHandleBase:
Close(),
Duplicate(),
Handle(),
SetHandle()
Inherited from RSessionBase:
Attach(),
CreateSession(),
EAutoAttach,
EExplicitAttach,
Send(),
SendReceive(),
SetRetry(),
Share(),
TAttachMode
RTelServer();
Empty default C++ constructor.
Constructs and empty RTelServer object, and is
present only to support virtual function table export.
|
TInt Connect(TInt aMessageSlots = KDefaultMessageSlots);
Connects the client to the ETel Server. It must be used before any of other functions during a telephony session.
|
|
|
TVersion Version() const;
Gets the version number of the ETel server.
|
TInt EnumeratePhones(TInt& aIndex) const;
Gets the total number of phones supported by all the currently loaded ETel (TSY) modules.
Note:
This function can be used in a for loop for use on
the GetPhoneInfo() function, which gets the phone information for
all TSYs.
|
|
TInt GetPhoneInfo(const TInt aIndex,TPhoneInfo& aInfo) const;
Gets information associated with the specified phone.
|
|
TInt GetTsyName(const TInt aIndexOfPhone, TDes& aTsyName) const;
Gets the name of the TSY module to which the phone belongs.
|
|
TInt GetTsyVersionNumber(const TDesC& aTsyName,TVersion& aVersion) const;
Supported from 5.1
Gets the version number of the specified TSY module.
|
|
TInt IsSupportedByModule(const TDesC& aTsyName, const TInt aMixin, TBool& aResult) const;
Tests what types of extended functionality a TSY module supports. It is assumed the TSY module supports all functionality defined in this, the core, API.
|
|
|
TInt LoadPhoneModule(const TDesC& aFileName) const;
Loads an ETel TSY module. The name of the TSY to be loaded can be obtained in two ways. Firstly it can be obtained by querying the CommDb for the current TSY. Secondly, users can find TSY names by searching the \System\Libs\ directory for files with the extension tsy.
Notes:
The file name need not include the TSY extension, as this is added by the server.
Once loaded, information about the phone(s) added by the module can be
accessed using the EnumeratePhones()
andGetPhoneInfo() functions.
The name for the TSY should not be hard coded, but rather obtained using the procedures described above.
|
|
TInt UnloadPhoneModule(const TDesC& aFileName) const;
Unloads an ETel TSY module.
Notes:
The file name need not include the TSY extension, as this is added by the server.
TSY modules are automatically unloaded when the
RTelServersession is closed, unless in use by another
session.
|
|
TInt SetExtendedErrorGranularity(const TErrorGranularity aGranularity) const;
Supported from 5.1
Requests the server to register the specified error granularity against the client which calls it.
The options for error granularity are:
core error granularity, the default, means that a client will only receive errors using ETel and System error codes
extended error granularity allows a client to receive richer error information, using additional proprietary client/TSY error codes
After registering interest in extended errors, the client will receive an extended error code whenever a requests ends in an error that is translated by the TSY into one of the proprietary extended error codes. If an error occurs that the TSY cannot translate into an extended error, then the TSY will return one of the core errors instead. For this reason, the core error space and the extended error space must not clash.
|
|
TInt SetPriorityClient() const;
Requests the server to allocate priority status to the client that calls it.
To prevent an out of memory error, the server uses pre-allocated memory to service the requests of priority clients.
Notes:
Only one client may have priority status in the system, and the first
client to ask for it receives it. If another application has been given
priority client status, the function
returnsKErrAlreadyExists.
Priority status should be requested early in an application's execution.
The server pre-allocates only a small amount of memory. If there is more than one active priority request it may run out. This is not an issue in ER5 as there is only one priority request — the emergency call.
|
|
Anonymous
Default number of message slots.
|
TErrorGranularity
Error granularity flags.
|
TNetworkType
Types of telephony connection flags.
|
|
TPhoneInfo
Phone information.
Defined in RTelServer::TPhoneInfo:
iExtensions, iName, iNetworkType, iNumberOfLines
![[Top]](../../../stock/arrow_up_2.gif){kind=icon}
iNetworkTypeTNetworkType iNetworkType
The type of telephony connection supported by the phone.
iNameTName iName
The name of the phone.
iNumberOfLinesTUint iNumberOfLines
The number of lines supported by the phone.
iExtensionsTUint iExtensions
The extensions that the TSY module supports.
Copyright ©2002 Symbian Ltd. 6.1-00174 |
|
![[Top]](../../../stock/arrow_up.gif){kind=icon}