EPOC   SDK Home Glossary Indexes Previous Next Up

The messaging classes


Send As messaging

Send As class — CSendAs class

Provides access to Send-As functionality. It allows applications to package data simply into outgoing messages.

Send-As client mixin — MSendAsObserver class

This abstract class should be implemented by clients using Send-As functionality.


MTM base classes

Client-side MTM base — CBaseMtm class

CBaseMtm-derived classes provide MTM-specific manipulation of entries to message client applications. Message client applications use the class to access such functionality polymorphically. MTM implementers derive from this class to provide such functionality for their message protocol.

User Interface MTM base — CBaseMtmUi class

CBaseMtmUi-derived classes provide MTM-specific user interaction, such as editing, viewing, deleting, and copying of message entries. Message client applications use the class to access such functionality polymorphically. MTM implementers derive from this class to provide such functionality for their message protocol.

UI Data MTM base — CBaseMtmUiData class

CBaseMtmUiData-derived classes allow message client applications to customise dynamically their user interfaces for a particular message type. Message client applications use the class to access such functionality polymorphically. MTM implementers derive from this class to provide such functionality for their message protocol.

Server-side MTM base — CBaseServerMtm class

CBaseServerMtm-derived classes provide message transport functionality, such as sending and receiving messages, for a particular messaging protocol. MTM implementers write such derived classes.


MTM factory functions

Client-side MTM factory — MtmFactoryFunctionL typedef

A factory function is called by the Client-side MTM registry when a client requests a particular Client-side MTM. It returns an instance of the CBaseMtm-derived class that provides the MTM implementation.

UI Data MTM factory — MtmUiDataFactoryFunctionL typedef

A factory function is called by the UI Data MTM registry when a client requests a particular UI Data MTM. It returns an instance of the CBaseMtmUiData-derived class that provides the MTM implementation.

User Interface MTM factory — MtmUiFactoryFunctionL typedef

A factory function is called by the User Interface MTM registry when a client requests a particular User Interface MTM. It returns an instance of the CBaseMtmUi-derived class that provides the MTM implementation.


MTM instantiation

MTM registry base — CMtmDllRegistry class

This class is the base for classes through which MTM components are instantiated. The derived classes used by clients are CClientMtmRegistry, CMtmUiDataRegistry, and CMtmUiRegistry.

Client-side MTM registry — CClientMtmRegistry class

This class is used for accessing the registered Client-side MTMs. Message client applications use this class to get a CBaseMtm-derived object by which to access Client-side MTM functionality.

UI Data MTM registry — CMtmUiDataRegistry class

This class is used for accessing the registered UI Data MTMs. Message client applications use this class to get a CBaseMtmUiData-derived object by which to access UI Data MTM functionality.

User Interface MTM registry — CMtmUiRegistry class

This class is used for accessing the registered User Interface MTM. Message client applications use this class to get a CBaseMtmUi-derived object by which to access User Interface MTM functionality.


Registration data

MTM group registry information — CMtmGroupData class

This class encapsulates the registration data for an MTM group. It provides read and write access to the registration data file for an MTM group.

MTM registry information array — CMtmDllInfoArray class

This class is used to collect the registration data for concrete MTM components, as encapsulated in CMtmDllInfo objects, into an array.

MTM registry information — CMtmDllInfo class

This class encapsulates the registration data for a single concrete MTM component.

MTM run-time registry information — CRegisteredMtmDll class

This utility class provides registry information to an instantiated MTM class.


Message Server entry access

Message Server entry — CMsvEntry class

This class is the central abstraction through which a program accesses and acts upon a particular Message Server entry. It provides means to access the various types of storage associated with an entry, and to discover and access other entries that the entry owns.

Entry access for Server-side MTMs — CMsvServerEntry class

This class is the central abstraction through which a Server-side MTM accesses and acts upon a particular Message Server entry. It provides similar functionality to that which CMsvEntry gives to client-side programs.

Entries array — CMsvEntrySelection class

This class encapsulates an array of entry IDs. An object of this type is commonly passed to a function to indicate the set of entries on which the function should operate.

Entry events notification — MMsvEntryObserver class

This mixin class provides the interface for notification of events associated with an entry.

Message part — TMsvPartList typedef

This type is used to specify one or more parts of a message in message–forwarding, message–reply, and message–validation functions.

Entry ordering — TMsvSelectionOrdering class

This class defines the sorting and grouping rules used to prepare a selection of entries. It is used in the interfaces of CMsvEntry and CMsvServerEntry to set the ordering of an entry’s children.

Sort order — TMsvSorting enum

This enumeration defines sort order options for a TMsvSelectionOrdering object.

Grouping order — TMsvGrouping enum

This enumeration defines grouping order options for a TMsvSelectionOrdering object.


Index entries

Structure of index entry — Index entry fields

Describes in detail the structure of an index entry.

Index entry — TMsvEntry class

This class represents an entry in the Message Server index. MTM implementations and message client applications use it to access and manipulate index entry values.

Message ID — TMsvId typedef

This type is used to specify an entry in the Message Server index.

Message priority — TMsvPriority enum

This enumeration supplies the standard values for the message priority index entry field.


Message store

Message store access — CMsvStore class

This class provides an interface over the message store that is associated with a message entry. This class is intended for use by MTM implementations. Message client applications access the store through the higher-level functions provided by Client-side and User Interface MTMs.

Stream read — RMsvReadStream class

This class is used to access the streams in a message store with read access. It is intended for use by MTM implementations to access MTM-specific information. Message client applications access the store through the higher-level functions provided by Client-side and User Interface MTMs.

Stream write — RMsvWriteStream class

This class is used to access the streams in a message store with write access, or to create new streams. It is intended for use by MTM implementations to store MTM-specific information. Message client applications access the store through the higher-level functions provided by Client-side and User Interface MTMs.


Message Server session

Message Server session — CMsvSession class

This class represents a channel of communication between a client thread (Client-side MTM, User Interface MTM, or message client application) and the Message Server thread.

Session events notification — MMsvSessionObserver class

This mixin class provides the interface for notification of events from a Message Server session.


Operations

Operation control — CMsvOperation class

This is an abstract base class, derived from CActive, which defines an interface for use by objects which control asynchronous commands in the messaging system. Such objects are returned by CMsvEntry and User Interface MTM functions that complete asynchronously.

Operation progress — TMsvLocalOperationProgress class

This class encapsulates progress information returned by a local operation. Understanding the TMsvLocalOperationProgress structure enables an application to use that information for a local operation.

Operation ID — TMsvOp typedef

This type is used to identify an asynchronous messaging operation.


Resources

MTM-specific operation array — MTUD_FUNCTION_ARRAY resource struct

This resource struct defines a group of MTM-specific operations (MTUD_FUNCTION structs) in an UI Data MTM resource file.

MTM-specific operation — MTUD_FUNCTION resource struct

Defines an MTM-specific operation in an UI Data MTM resource file.


Constants

Miscellaneous constants — Constants

Describes constants used for defining such things as types of entry, and MTM-specific operations in UI Data MTM resource files.

Panic codes — Message Server Panics

Describes the various types of panic that the Message Server can give.

EPOC       SDK Home Glossary Indexes Previous Next Up