Handle to a message queue

# Date 1279297426 -3600 # Node ID 80ef3a20677267274926b513266603a8729fb389 # Parent 5072524fcc7971cb6e13ae797e9b1c05ae631a13 Week 28 contribution of PDK documentation content. See release notes for details. Fixes bugs Bug 1897, Bug 344, Bug 2681, Bug 463, Bug 1522. diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/92_201008_S60.52_apidocsP_sf.zip Binary file Symbian3/PDK/Source/92_201008_S60.52_apidocsP_sf.zip has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-000ACB11-EDD0-5160-BC5E-4593F1BAF293.dita --- a/Symbian3/PDK/Source/GUID-000ACB11-EDD0-5160-BC5E-4593F1BAF293.dita Fri Jul 02 12:51:36 2010 +0100 +++ b/Symbian3/PDK/Source/GUID-000ACB11-EDD0-5160-BC5E-4593F1BAF293.dita Fri Jul 16 17:23:46 2010 +0100 @@ -39,7 +39,7 @@ to it is closed. The queue itself is simply a block of memory divided into slots, managed by the DMsgQueue object.

- +

A message queue is created, opened, written to and @@ -50,7 +50,7 @@ the implementation, while RMsgQueue provides type safety. An RMsgQueueBase object is a valid message queue handle, but does not offer the type safety that RMsgQueue does.

- +

Message queues are used for one-way, one to one communications only. The message queue is therefore unicast. If there are multiple readers of the message queue only one will receive the message.

diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-006C503D-1E52-450D-A4DA-8C19B141E09F.dita --- a/Symbian3/PDK/Source/GUID-006C503D-1E52-450D-A4DA-8C19B141E09F.dita Fri Jul 02 12:51:36 2010 +0100 +++ b/Symbian3/PDK/Source/GUID-006C503D-1E52-450D-A4DA-8C19B141E09F.dita Fri Jul 16 17:23:46 2010 +0100 @@ -15,7 +15,7 @@ where C and C++ (and Symbian C++ as well) codes will be used together. The open source community implements a vast number of libraries that export C APIs to the user of such libraries. -

When +<section id="GUID-88635D46-AEF6-4E8E-969D-D3E56941F289-GENID-1-12-1-14-1-1-5-1-3-1-7-1-4-1-4-1-3-1"> <title>When and why to use C linkage

While porting such applications, if developers have to intermix C and C++ code, they then have to depend on C++ language features like extern "C" for giving C linkage to some set of @@ -32,7 +32,7 @@ It applies when the developer tries to use C APIs by including corresponding headers. To avoid name mangling, the developer should mention explicitly that those APIs are C APIs, by using the extern "C" keyword.

Syntax +<section id="GUID-88635D46-AEF6-4E8E-969D-D3E56941F289-GENID-1-12-1-14-1-1-5-1-3-1-7-1-4-1-4-1-3-2"> <title>Syntax of extern C

The syntax of extern "C" is shown below:

extern "C" declaration ;

The declaration (or definition) that immediately follows extern "C" has the C linkage.

extern "C" { @@ -41,7 +41,7 @@ ... }

Everything between the curly braces has C linkage, unless declared otherwise.

How +<section id="GUID-88635D46-AEF6-4E8E-969D-D3E56941F289-GENID-1-12-1-14-1-1-5-1-3-1-7-1-4-1-4-1-3-3"> <title>How to use extern C

While writing header files with C functions which will be included by both C and C++ source files, the user must use extern "C" properly. See the example below:

/*File: GoodCHeader.h */ @@ -83,7 +83,7 @@ int ret = Function2(10); }

Mixing +<section id="GUID-88635D46-AEF6-4E8E-969D-D3E56941F289-GENID-1-12-1-14-1-1-5-1-3-1-7-1-4-1-4-1-3-4"> <title>Mixing C and C++ features using extern "C"

The developer can use all the features of C++ except templates within C by giving those functions extern "C" linkage. See the example below:

#include <iostream> diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-009D71C6-481F-5EF1-B230-EB64F67047C8.dita --- a/Symbian3/PDK/Source/GUID-009D71C6-481F-5EF1-B230-EB64F67047C8.dita Fri Jul 02 12:51:36 2010 +0100 +++ b/Symbian3/PDK/Source/GUID-009D71C6-481F-5EF1-B230-EB64F67047C8.dita Fri Jul 16 17:23:46 2010 +0100 @@ -15,7 +15,7 @@

The platform specific layer performs the following calculation to convert between ADC values and co-ordinates:

- +

Where the R matrix determines the scaling and rotation, and the T vector determines the translation.

diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-01029B52-55E0-5598-994F-BB5DE73D37EE.dita --- a/Symbian3/PDK/Source/GUID-01029B52-55E0-5598-994F-BB5DE73D37EE.dita Fri Jul 02 12:51:36 2010 +0100 +++ b/Symbian3/PDK/Source/GUID-01029B52-55E0-5598-994F-BB5DE73D37EE.dita Fri Jul 16 17:23:46 2010 +0100 @@ -11,6 +11,6 @@ PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> What are LayersThis topic describes the concept of a Layer in the Communications Framework.

A Layer is a horizontal division of functionality in a stack.

A Layer matches the concept of the Layer in the seven-layer International Organization for Standardization's OSI Model. A Layer also matches the concept of the Layer in the five layer model used to describe TCP/IP.

A Layer can contain a single Communications Protocol. A Layer can also contain a number of related protocols collected into a single unit. TLS, TCP, IP, Ethernet are examples of the protocols.

The concept of a Layer allows device creators to have different implementations in a given Layer. When a data connection starts or when the environment changes, the best protocol can be selected.

The following diagram shows the concept. The diagram also shows the position of the Sockets Server Client APIs.

Layers in the Communications Framework -

Although each Layer contains a different protocol, the Communications Framework allows separate protocols to make a single Layer. For example: NCP, LCP and HDLC together make the PPP protocol. TCP, UDP, ICMP, IP together make the TCP/IP group of protocols. Each of these groups of protocols can be put together into a single Layer.

The number of Layers only depends on the configuration of the Communications Stack. The top Layer has the Sockets Server. The bottom Layer has the drivers for the communication hardware . Each Layer interacts only with the Layer immediately above and the Layer immediately below.

The framework APIs that connect the protocols in each Layer are consistent across the Communications Framework. All protocols share a common method of communication that is independent of protocol behaviour. A common method of communication allows protocols to be stacked. The Communications Framework provides flexibility in the configuration of the protocol stacks for each device. The following diagram shows a number of protocols at each Layer.

Protocols arranged in Layers in the Communications Framework -

Socket Server

\ No newline at end of file + Socket Server \ No newline at end of file diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-0142B290-DA6C-5574-83D7-7555D804D9B5.dita --- a/Symbian3/PDK/Source/GUID-0142B290-DA6C-5574-83D7-7555D804D9B5.dita Fri Jul 02 12:51:36 2010 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,75 +0,0 @@ - - - - - -How -to initialise array RESOURCE members -

<array-initialiser>

array-initialiser ::=

{ <array-initialiser-item-comma-list> } <array-initialiser-item>

array-initialiser-item ::=

<initialiser>

Fixed-length arrays

If a member is declared as a fixed-length array in the STRUCT or RESOURCE definition, -for example,

-WORD elements[10] -

then you must not specify any more items than were given in the length.

If fewer items are specified in the default initialisation (i.e. in the STRUCT definition), -then an error also results.

Note that no values will be given to unspecified elements at the end of -the array, even if they have been default initialised in the STRUCT definition. -Take the following example:

-STRUCT SAMPLE - { - BYTE bts[3]={1,2,3}; - } -

In the following resource:

-RESOURCE SAMPLE default - {} -

the output will be the whole default array

-0x01 0x02 0x03 -

but in this resource:

-RESOURCE SAMPLE first_specified - { - bts={5}; - } -

the output is:

-0x05 -

with the second and third elements lost.

If you specify only the second element in the RESOURCE definition, -then the first element is taken from the default initialisation, the second -from the explicit initialisation and the third element is lost. The following -resource:

-RESOURCE SAMPLE second_specified - { - bts[1]=5; - } -

results in the 2-byte output:

-0x01 0x05 -

If, however, you explicitly initialise an element in the middle of an array -without having supplied default values for array members before it, then an -error will result.

Using expressions to initialise array elements

You -may initialise array elements with expressions. You must explicitly initialise -each member component of the array otherwise the expressions will be evaluated -incorrectly. The following resource:

RESOURCE SAMPLE correct_expression - { - bts[0]=3+1; - bts[1]=2; - bts[2]=3; - }

will generate the correct output 0x04 0x02 0x03. -However, if you use the following syntax:

RESOURCE SAMPLE incorrect_expression - { - bts={3+1,2,3}; - }

the output will be 0x03 0x02 0x03. This -is because the pre-processor treats 3+1 as a literal string -that is then interpreted by the compiler as 3. In the resource correct_expression above -the ‘=‘ sign forces the pre-processor to evaluate the expression.

- \ No newline at end of file diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-016704BE-DC2B-5AD3-B9BE-76A327678B38_d0e357477_href.jpg Binary file Symbian3/PDK/Source/GUID-016704BE-DC2B-5AD3-B9BE-76A327678B38_d0e357477_href.jpg has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-016704BE-DC2B-5AD3-B9BE-76A327678B38_d0e363354_href.jpg Binary file Symbian3/PDK/Source/GUID-016704BE-DC2B-5AD3-B9BE-76A327678B38_d0e363354_href.jpg has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-016876C8-7E13-5A3E-9A15-992B7EEEEA38.dita --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Symbian3/PDK/Source/GUID-016876C8-7E13-5A3E-9A15-992B7EEEEA38.dita Fri Jul 16 17:23:46 2010 +0100 @@ -0,0 +1,14 @@ + + + + + +Software Component +RegistryThe Software Component Registry (SCR) is a unified registry of +native and non-native software components. \ No newline at end of file diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-0181F4BD-51A2-49AF-9DAC-517F8BAD8DBC_d0e80547_href.png Binary file Symbian3/PDK/Source/GUID-0181F4BD-51A2-49AF-9DAC-517F8BAD8DBC_d0e80547_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-0181F4BD-51A2-49AF-9DAC-517F8BAD8DBC_d0e84745_href.png Binary file Symbian3/PDK/Source/GUID-0181F4BD-51A2-49AF-9DAC-517F8BAD8DBC_d0e84745_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-0185D5DC-5142-42C3-8FFB-8EB76D49AB06.dita --- a/Symbian3/PDK/Source/GUID-0185D5DC-5142-42C3-8FFB-8EB76D49AB06.dita Fri Jul 02 12:51:36 2010 +0100 +++ b/Symbian3/PDK/Source/GUID-0185D5DC-5142-42C3-8FFB-8EB76D49AB06.dita Fri Jul 16 17:23:46 2010 +0100 @@ -21,8 +21,8 @@ for the request to complete. This approach is not recommended in case of a server, as synchronous call blocks the server and it cannot serve its clients during synchronous wait.

- -Request free memory. + +Request free memory. User::LeaveIfError(iOomMonitorSession.RequestFreeMemory(KLargeValueToAllocate)); DoFunctionRequiring_KLargeValueToAllocate_Bytes(); diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-018A685B-5C9D-5C7C-8615-D413ABBF7CFB_d0e343841_href.png Binary file Symbian3/PDK/Source/GUID-018A685B-5C9D-5C7C-8615-D413ABBF7CFB_d0e343841_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-018A685B-5C9D-5C7C-8615-D413ABBF7CFB_d0e349792_href.png Binary file Symbian3/PDK/Source/GUID-018A685B-5C9D-5C7C-8615-D413ABBF7CFB_d0e349792_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-01943C50-E3AB-5D5B-BC3D-B399C6BFD155-GENID-1-12-1-24-1-1-8-1-4-1-4-1-4-1-3-1.dita --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Symbian3/PDK/Source/GUID-01943C50-E3AB-5D5B-BC3D-B399C6BFD155-GENID-1-12-1-24-1-1-8-1-4-1-4-1-4-1-3-1.dita Fri Jul 16 17:23:46 2010 +0100 @@ -0,0 +1,12 @@ + + + + + +Secure Sockets ArchitectureThis section describes the architectural relationships of the Secure Sockets.

Architectural relationships

The Secure sockets architecture provides a client interface and a server. Protocol modules are plugged into the client. The client uses protocol modules to supply protocol-specific parameters to the Secure Socket API functions.

The ssl.dll plug-in supports the Transport Layer Security (TLS) v1.0 and Secure Sockets Layer (SSL) v3.0. The protocols use the socket methods to pass data between a client and a server. This method prevents the security violations.

The following diagram shows the relationship between an application and the secure sockets.

See also

Sockets Server

\ No newline at end of file diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-01943C50-E3AB-5D5B-BC3D-B399C6BFD155-GENID-1-12-1-24-1-1-8-1-5-1-4-1-4-1-3-1.dita --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Symbian3/PDK/Source/GUID-01943C50-E3AB-5D5B-BC3D-B399C6BFD155-GENID-1-12-1-24-1-1-8-1-5-1-4-1-4-1-3-1.dita Fri Jul 16 17:23:46 2010 +0100 @@ -0,0 +1,12 @@ + + + + + +Secure Sockets ArchitectureThis section describes the architectural relationships of the Secure Sockets.

Architectural relationships

The following diagram shows the relationship between an application and the secure sockets.

See also

Sockets Server

\ No newline at end of file diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-01943C50-E3AB-5D5B-BC3D-B399C6BFD155-GENID-1-12-1-24-1-1-9-1-4-1-4-1-3-1.dita --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Symbian3/PDK/Source/GUID-01943C50-E3AB-5D5B-BC3D-B399C6BFD155-GENID-1-12-1-24-1-1-9-1-4-1-4-1-3-1.dita Fri Jul 16 17:23:46 2010 +0100 @@ -0,0 +1,12 @@ + + + + + +Secure Sockets ArchitectureThis section describes the architectural relationships of the Secure Sockets.

Architectural relationships

The following diagram shows the relationship between an application and the secure sockets.

See also

Sockets Server

\ No newline at end of file diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-01979029-C009-5FD3-9925-2B7945FB96A6.dita --- a/Symbian3/PDK/Source/GUID-01979029-C009-5FD3-9925-2B7945FB96A6.dita Fri Jul 02 12:51:36 2010 +0100 +++ b/Symbian3/PDK/Source/GUID-01979029-C009-5FD3-9925-2B7945FB96A6.dita Fri Jul 16 17:23:46 2010 +0100 @@ -9,7 +9,7 @@ --> -Restarting a Network Connection TutorialThis section describes the steps used to start a network connection that was stopped due to contention.

Introduction

A low priority connection is terminated when a contention issue occurs and the incoming connection has a higher priority. The low priority connection can be restarted when the higher priority connection is complete. For example, if an always-on Internet connection is terminated to enable the user to send an MMS, the Internet connection is restarted when the message is sent.

Introduction

To terminate the high priority connection on of the following occurs:
1. The Connection Provider (CPR) receives a TStopNormal message to terminate the process.
2. The connection remains idle and is automatically terminated.
The PDP Tier Manager does the following:
1. Indicates to the PDP Meta-Connection Provider (MCPR) of the low priority connection that it can restore the connection.
2. The PDP MCPR sends an availability notification to the CConnection of the low priority connection.
CConnection of the low priority connection receives the availability notification and uses RConnection::Start(TConnPrefList) to establish the connection.

Restoring a connection

Use the following code to ensure a stopped connection is restored when the higher priority connection has completed.

+Restarting a Network Connection TutorialThis section describes the steps used to start a network connection that was stopped due to contention.

Introduction

To terminate the high priority connection on of the following occurs:
1. The Connection Provider (CPR) receives a TStopNormal message to terminate the process.
2. The connection remains idle and is automatically terminated.
The PDP Tier Manager does the following:
1. Indicates to the PDP Meta-Connection Provider (MCPR) of the low priority connection that it can restore the connection.
2. The PDP MCPR sends an availability notification to the CConnection of the low priority connection.
CConnection of the low priority connection receives the availability notification and uses RConnection::Start(TConnPrefList) to establish the connection.

Restoring a connection

Use the following code to ensure a stopped connection is restored when the higher priority connection has completed.

TConnPrefList* prefs = TConnPrefList::NewL(); CleanupStack::PushL(prefs); diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-01F1C399-25F6-54E8-B48D-521187A63096.dita --- a/Symbian3/PDK/Source/GUID-01F1C399-25F6-54E8-B48D-521187A63096.dita Fri Jul 02 12:51:36 2010 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,12 +0,0 @@ - - - - - -Capability Management tools \ No newline at end of file diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-01F1F488-8E95-56B0-818E-6096CAE4C50C.dita --- a/Symbian3/PDK/Source/GUID-01F1F488-8E95-56B0-818E-6096CAE4C50C.dita Fri Jul 02 12:51:36 2010 +0100 +++ b/Symbian3/PDK/Source/GUID-01F1F488-8E95-56B0-818E-6096CAE4C50C.dita Fri Jul 16 17:23:46 2010 +0100 @@ -20,6 +20,6 @@ diagram shows the relative position of the Base Starter in the start-up sequence.

Base Starter architecture - + \ No newline at end of file diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-02072A1B-6F60-457B-8F26-2B25A6EA7C5F_d0e101253_href.png Binary file Symbian3/PDK/Source/GUID-02072A1B-6F60-457B-8F26-2B25A6EA7C5F_d0e101253_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-02072A1B-6F60-457B-8F26-2B25A6EA7C5F_d0e90319_href.png Binary file Symbian3/PDK/Source/GUID-02072A1B-6F60-457B-8F26-2B25A6EA7C5F_d0e90319_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-02072A1B-6F60-457B-8F26-2B25A6EA7C5F_d0e94517_href.png Binary file Symbian3/PDK/Source/GUID-02072A1B-6F60-457B-8F26-2B25A6EA7C5F_d0e94517_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-02072A1B-6F60-457B-8F26-2B25A6EA7C5F_d0e97174_href.png Binary file Symbian3/PDK/Source/GUID-02072A1B-6F60-457B-8F26-2B25A6EA7C5F_d0e97174_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-0211CAA4-32FF-52F2-81DA-78C52C412AED_d0e155252_href.png Binary file Symbian3/PDK/Source/GUID-0211CAA4-32FF-52F2-81DA-78C52C412AED_d0e155252_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-0211CAA4-32FF-52F2-81DA-78C52C412AED_d0e161353_href.png Binary file Symbian3/PDK/Source/GUID-0211CAA4-32FF-52F2-81DA-78C52C412AED_d0e161353_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-023268BB-8C52-51A1-9E3B-4C7E265DFDAB.dita --- a/Symbian3/PDK/Source/GUID-023268BB-8C52-51A1-9E3B-4C7E265DFDAB.dita Fri Jul 02 12:51:36 2010 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,12 +0,0 @@ - - - - - --wrap-wrap[=<value>]

A static analysis tool can be invoked if [=<value>] is not specified. For example, -wrap.

The name of the static analysis tool executable is set using the environment variable ABLD_COMPWRAP. For more information, see How to invoke a static analysis tool using abld.

\ No newline at end of file diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-023D30F0-C1E8-5E09-92AD-C5A7963DCF70_d0e512262_href.jpg Binary file Symbian3/PDK/Source/GUID-023D30F0-C1E8-5E09-92AD-C5A7963DCF70_d0e512262_href.jpg has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-023D30F0-C1E8-5E09-92AD-C5A7963DCF70_d0e519724_href.jpg Binary file Symbian3/PDK/Source/GUID-023D30F0-C1E8-5E09-92AD-C5A7963DCF70_d0e519724_href.jpg has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-02442ADC-1C4C-5489-825F-7E1630415086_d0e230144_href.png Binary file Symbian3/PDK/Source/GUID-02442ADC-1C4C-5489-825F-7E1630415086_d0e230144_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-02442ADC-1C4C-5489-825F-7E1630415086_d0e236139_href.png Binary file Symbian3/PDK/Source/GUID-02442ADC-1C4C-5489-825F-7E1630415086_d0e236139_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-02521DB0-53C4-55D5-856F-BD478E134B73_d0e547910_href.png Binary file Symbian3/PDK/Source/GUID-02521DB0-53C4-55D5-856F-BD478E134B73_d0e547910_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-02521DB0-53C4-55D5-856F-BD478E134B73_d0e555366_href.png Binary file Symbian3/PDK/Source/GUID-02521DB0-53C4-55D5-856F-BD478E134B73_d0e555366_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-0259868F-8F88-5D9D-A9DE-9309C3BFBA85_d0e478805_href.png Binary file Symbian3/PDK/Source/GUID-0259868F-8F88-5D9D-A9DE-9309C3BFBA85_d0e478805_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-0259868F-8F88-5D9D-A9DE-9309C3BFBA85_d0e484634_href.png Binary file Symbian3/PDK/Source/GUID-0259868F-8F88-5D9D-A9DE-9309C3BFBA85_d0e484634_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-02659624-4C27-573C-BE2E-0250D860BEA3.dita --- a/Symbian3/PDK/Source/GUID-02659624-4C27-573C-BE2E-0250D860BEA3.dita Fri Jul 02 12:51:36 2010 +0100 +++ b/Symbian3/PDK/Source/GUID-02659624-4C27-573C-BE2E-0250D860BEA3.dita Fri Jul 16 17:23:46 2010 +0100 @@ -9,6 +9,6 @@ --> -Media Client Video Display OverviewThis document provides an overview of the Media Client Video Display library that is used by the Video Client library in the Multimedia Framework component.

Purpose

The Media Client Video Display library allows you to display video in a window and to support a graphic surface.

Media Client Video Display library details

The DLL that provides the functionality and the library to which your code must link is identified below.

DLL LIB Short description

mediaclientvideodisplay.dll

mediaclientvideodisplay.lib

These files are used to implement the display video functionality and support graphics surfaces.

Architecture

Media Client Video Display is a standalone library used by the Video Client library to support video display. This allows you to use video display functionality separately from the client utilities. The class diagram forCMediaClientVideoDisplay is as follows:

Description

The Media Client Video Display library is a client interface to access display functions. The display functions are as follows:

Adding a new window
Redrawing the window
Setting the video data for automatic and specified dimension scaling
Rotating the video image
Clipping the window
Setting the video extension on the screen that is relative to the window.

The Media Client Video Display library allows you to perform rendering of video to graphics surfaces. It provides APIs to:

Create the graphic surface
Update the graphic surface
Surface parameters changed during video play back
Remove the graphic surface.

APIs

The key class of Media Client Video Display is as follows:

API Description

CMediaClientVideoDisplay

This class is an interface to add or remove video display windows. The CMediaClientVideoDisplay class supports graphics surfaces and provides display handling functions like video extension, scaling and rotation.

Using Media Client Video Display

Clients use CMediaClientVideoDisplay to:

Display video in a window
Support graphics surfaces.

Media Client Video Display +Media Client Video Display OverviewThis document provides an overview of the Media Client Video Display library that is used by the Video Client library in the Multimedia Framework component.

Purpose

The Media Client Video Display library allows you to display video in a window and to support a graphic surface.

Media Client Video Display library details

The DLL that provides the functionality and the library to which your code must link is identified below.

DLL LIB Short description

mediaclientvideodisplay.dll

mediaclientvideodisplay.lib

These files are used to implement the display video functionality and support graphics surfaces.

Architecture

Description

The Media Client Video Display library is a client interface to access display functions. The display functions are as follows:

Adding a new window
Redrawing the window
Setting the video data for automatic and specified dimension scaling
Rotating the video image
Clipping the window
Setting the video extension on the screen that is relative to the window.

The Media Client Video Display library allows you to perform rendering of video to graphics surfaces. It provides APIs to:

Create the graphic surface
Update the graphic surface
Surface parameters changed during video play back
Remove the graphic surface.

APIs

The key class of Media Client Video Display is as follows:

API Description

CMediaClientVideoDisplay

Using Media Client Video Display

Clients use CMediaClientVideoDisplay to:

Display video in a window
Support graphics surfaces.

Media Client Video Display Tutorial Video Client Overview Graphics Composition Surfaces

\ No newline at end of file diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-0268102D-D238-5C5E-818F-6ACC4A85B022_d0e8848_href.png Binary file Symbian3/PDK/Source/GUID-0268102D-D238-5C5E-818F-6ACC4A85B022_d0e8848_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-0268102D-D238-5C5E-818F-6ACC4A85B022_d0e8970_href.png Binary file Symbian3/PDK/Source/GUID-0268102D-D238-5C5E-818F-6ACC4A85B022_d0e8970_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-026E865E-12FA-59A9-B923-309B65790E23.dita --- a/Symbian3/PDK/Source/GUID-026E865E-12FA-59A9-B923-309B65790E23.dita Fri Jul 02 12:51:36 2010 +0100 +++ b/Symbian3/PDK/Source/GUID-026E865E-12FA-59A9-B923-309B65790E23.dita Fri Jul 16 17:23:46 2010 +0100 @@ -19,7 +19,7 @@

The flowchart below shows the steps to create a Fat Filename Conversion plug-in DLL.

- +

Note: To create the plug-in DLL, the unicodeconv.cpp file is needed. It provides the functions to convert text between Unicode and a foreign encoding. It is available on the Symbian Foundation web site.

This tutorial diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-02970C7B-5B98-50C7-A324-0DDD71120DEB_d0e228901_href.png Binary file Symbian3/PDK/Source/GUID-02970C7B-5B98-50C7-A324-0DDD71120DEB_d0e228901_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-02970C7B-5B98-50C7-A324-0DDD71120DEB_d0e234899_href.png Binary file Symbian3/PDK/Source/GUID-02970C7B-5B98-50C7-A324-0DDD71120DEB_d0e234899_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-02F4AA24-283A-503D-8BA9-7C926DC7E306_d0e638138_href.png Binary file Symbian3/PDK/Source/GUID-02F4AA24-283A-503D-8BA9-7C926DC7E306_d0e638138_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-02F4AA24-283A-503D-8BA9-7C926DC7E306_d0e650960_href.png Binary file Symbian3/PDK/Source/GUID-02F4AA24-283A-503D-8BA9-7C926DC7E306_d0e650960_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-032BE80C-CF9B-564C-B2F8-F254B12699CB.dita --- a/Symbian3/PDK/Source/GUID-032BE80C-CF9B-564C-B2F8-F254B12699CB.dita Fri Jul 02 12:51:36 2010 +0100 +++ b/Symbian3/PDK/Source/GUID-032BE80C-CF9B-564C-B2F8-F254B12699CB.dita Fri Jul 16 17:23:46 2010 +0100 @@ -1,116 +1,237 @@ - - - - - -Release NotesThe Symbian Developer Library for Product Developers is -intended for device developers and contributors to the Symbian platform. -The information in the library corresponds to the Symbian^3 platform -release. -

Major -changes between the week 12 2010 release and week 22 2010 release

Since the week 12 2010 documentation submission to the Symbian -Foundation, the following major additions have been made:

CryptoSPI - documentation.
API -changes and compatibility breaks.
Time -Zone Services overviews and tutorials.
IP Connection -Management.

Bug fixes:

This release contains fixes for the -following bugs and known issues:

Symbian^3 documentation.
Buildrom content is missing.
Some links to Multimedia example code occur more than once -in the table of contents and in landing pages.
Links to the Open C examples in the full example code list -are broken.
Broken and incorrect links in Platform security architecture -and Optional resource file statements topics.
The breadcrumb trails for Application framework guide, Multimedia -example code and System GUI Framework example code are wrong and contains -duplicates.

Major -changes between the week 03 2010 release and week 12 2010 release

Since the week 03 2010 documentation submission to the Symbian -Foundation, the following major additions have been made:

Inclusion of API reference extracted from the Symbian^3 source -code.
Inclusion of API specifications.
A new About Symbian^3 topic, including What's new and Porting applications -from S60 5th Edition to Symbian^3.
A new Getting Started topic, consisting of the Symbian Foundation's -C++ Quick Start and Going Beyond Hello tutorials.
Integration of the Panic Codes Reference.
Addition of new topics: Common Email Guide and System -Resource Monitoring.
The Graphics Guide has been updated for Symbian^3. For details, -see What's -New in Graphics in Symbian^3.
The Classic UI Guide has been updated for Symbian^3.
All guides have been updated to refer to the Symbian platform -rather than to Symbian OS and to S60, apart from where it is necessary -to refer to past releases.

Bug fixes:

This release contains fixes for the -following bugs:

Change section headings in Symbian^3 product/app -reference
Fix up the links in the Platform security architecture -page
Link to sample chapter of quick recipes book in SDK -docs
Remove "Using the Indexes"
ambiguous documentation of text-options
Remove references to SDN and SDN++ from Symbian Developer -Library
Guide landing page is empty
Change references to "Template Port" in the kernel -& hardware services guide
Example of sharing chunks between surfaces is confusing -(maybe incorrect?)
Comments on graphics composition overview
Documentation for WDP device driver migration is -wrong
Please Check/Update the Paths used in the Reference -Library

Major -changes between the week 43 2009 release and week 03 2010 release

New content:

Classic -UI Guide
High -Level Internet Protocols Guide
Short -Link Services Guide
Web -Guide

The following S60 5th Edition C++ Developer's Library 'Technology -area guides' have been integrated into the Symbian guide:

Application -and UI frameworks is now in Classic UI Guide.
S60 -UI components is now in Classic UI Guide.
Multimedia is now in Multimedia Guide.
Browsing -and downloading is now in Web Guide.
Location is now in Location Based Services (LBS).
Security is now found at the top level.

The S60 Open C and Open C++ documentation has been merged -into the Symbian P.I.P.S. documentation and is now in Generic OS Services -Guide.

Other changes:

The Symbian Developer -Library is now released under the Eclipse Public License (EPL).

Known -issues in the week 22 2010 release

See Known issues with Symbian3 product developers -library.

Upcoming -releases and improvements in the Symbian Developer Library for Product -Developers

See the Documentation Content Package Backlog.

Feedback

To give feedback, please go to the Symbian Foundation Bugtracker (login required).

\ No newline at end of file + + + + +Release Notes +The Symbian Developer Library for Product Developers is +intended for device developers and contributors to the Symbian platform. +The information in the library corresponds to the Symbian^3 platform +release. + + + + + + +

Major changes between the week 22 2010 release and +week 28 2010 release

The following API specifications are +new (Product Developer Library build only):

AI Content Model API
AI Plug-in Management API
AI Utilities API
Discreet Pop-up API
Generic AHL API
HS Content Control API
HS External Rendering Plug-in API
HS Settings API
Idle Fw API
Menu Content Service API
Network Positioning Proxy Configuration API
Touch Gesture Framework API

Other changes:

The PIM Application Engines and Services section has been split +into Contacts +Guide and Organizer Guide to match the Symbian Foundation package structure.
The Tools and Utilities section has been removed. The content +previously included in this section will be delivered with other Tools +documentation in the Symbian^3 and Symbian^4 Tools Guides (coming +soon).

Bug fixes:

This release contains fixes for the +following bugs:

Guide landing page is empty
Remove references to SDN and SDN++ from Symbian Developer +Library
Code listings in API specs are unreadable
Change references to "Template Port" in the kernel +& hardware services guide
Fix up the links in the Platform security architecture +page

Major +changes between the week 12 2010 release and week 22 2010 release

Since the week 12 2010 documentation submission to the Symbian +Foundation, the following major additions have been made:

CryptoSPI documentation.
API changes and compatibility breaks.
Time Zone Services overviews and tutorials.
IP Connection Management.

Bug fixes:

This release contains fixes for the +following bugs and known issues:

Symbian^3 documentation.
Buildrom content is missing.
Some links to Multimedia example code occur more than once +in the table of contents and in landing pages.
Links to the Open C examples in the full example code list +are broken.
Broken and incorrect links in Platform security architecture +and Optional resource file statements topics.
The breadcrumb trails for Application framework guide, Multimedia +example code and System GUI Framework example code are wrong and contains +duplicates.

Major +changes between the week 03 2010 release and week 12 2010 release

Since the week 03 2010 documentation submission to the Symbian +Foundation, the following major additions have been made:

Inclusion of API reference extracted from the Symbian^3 source +code.
Inclusion of API specifications.
A new About Symbian^3 topic, including What's new and Porting applications +from S60 5th Edition to Symbian^3.
A new Getting Started topic, consisting of the Symbian Foundation's +C++ Quick Start and Going Beyond Hello tutorials.
Integration of the Panic Codes +Reference.
Addition of new topics: Common Email +Guide and System Resource +Monitoring.
The Graphics Guide has been updated for Symbian^3. For details, +see What's +New in Graphics in Symbian^3.
The Classic UI Guide has been updated for Symbian^3.
All guides have been updated to refer to the Symbian platform +rather than to Symbian OS and to S60, apart from where it is necessary +to refer to past releases.

Bug fixes:

This release contains fixes for the +following bugs:

Change section headings in Symbian^3 product/app +reference
Fix up the links in the Platform security architecture +page
Link to sample chapter of quick recipes book in SDK +docs
Remove "Using the Indexes"
ambiguous documentation of text-options
Remove references to SDN and SDN++ from Symbian Developer +Library
Guide landing page is empty
Change references to "Template Port" in the kernel +& hardware services guide
Example of sharing chunks between surfaces is confusing +(maybe incorrect?)
Comments on graphics composition overview
Documentation for WDP device driver migration is +wrong
Please Check/Update the Paths used in the Reference +Library

Major +changes between the week 43 2009 release and week 03 2010 release

New content:

Classic UI Guide
High Level Internet Protocols Guide
Short Link Services Guide
Web Guide

The following S60 5th Edition C++ Developer's Library 'Technology +area guides' have been integrated into the Symbian guide:

Application and UI frameworks is now in Classic UI Guide.
S60 UI components is now in Classic UI Guide.
Multimedia is now in Multimedia Guide.
Browsing and downloading is now in Web Guide.
Location is now in Location Based Services (LBS).
Security is now found at the top level.

The S60 Open C and Open C++ documentation has been merged +into the Symbian P.I.P.S. documentation and is now in Generic OS Services +Guide.

Other changes:

The Symbian Developer +Library is now released under the Eclipse Public License (EPL).

Known +issues in the week 28<?Pub Caret?> 2010 release

See Known issues with Symbian3 product developers library.

Upcoming +releases and improvements in the Symbian Developer Library for Product +Developers

See the Documentation Content Package Backlog.

Feedback

To give feedback, please go to the Symbian Foundation Bugtracker (login required).

+ + + diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-0348B62D-1AE0-45F5-B06E-9EE2D83326E8.dita --- a/Symbian3/PDK/Source/GUID-0348B62D-1AE0-45F5-B06E-9EE2D83326E8.dita Fri Jul 02 12:51:36 2010 +0100 +++ b/Symbian3/PDK/Source/GUID-0348B62D-1AE0-45F5-B06E-9EE2D83326E8.dita Fri Jul 16 17:23:46 2010 +0100 @@ -25,7 +25,7 @@ general, only the most important status indicators are displayed.

Universal status indicators displayed in the top-right corner - +

Using universal indicators in applications

The universal diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-03671C88-6911-5184-A9D4-A2D2FD69A2B9_d0e665539_href.png Binary file Symbian3/PDK/Source/GUID-03671C88-6911-5184-A9D4-A2D2FD69A2B9_d0e665539_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-03671C88-6911-5184-A9D4-A2D2FD69A2B9_d0e678366_href.png Binary file Symbian3/PDK/Source/GUID-03671C88-6911-5184-A9D4-A2D2FD69A2B9_d0e678366_href.png has changed diff -r 5072524fcc79 -r 80ef3a206772 Symbian3/PDK/Source/GUID-037DFEEE-757A-5C0B-AAA7-62E3E39FAF30.dita --- a/Symbian3/PDK/Source/GUID-037DFEEE-757A-5C0B-AAA7-62E3E39FAF30.dita Fri Jul 02 12:51:36 2010 +0100 +++ b/Symbian3/PDK/Source/GUID-037DFEEE-757A-5C0B-AAA7-62E3E39FAF30.dita Fri Jul 16 17:23:46 2010 +0100 @@ -9,7 +9,7 @@ --> -Migrating from Feature Registry to Feature ManagerProvides detailed instructions for migrating Feature registry to Feature Manager runtime and buildtime.

Migrating to Feature Manager runtime APIs
Migrating to Feature Manager buildtime tooling

Migrating to Feature Manager runtime APIs

FeatureRegistry queries the presence of a feature with the functions QuerySupport() and QuerySupportS() which are now deprecated. The publishPartner version of Feature Manager implements the corresponding functionality with a choice of function calls, either static or dynamic. The SDK version only provides the static function calls.

Old New

TInt RFeatureRegistry:: QuerySupport(TUid aFeatureUid)

TInt RFeatureControl:: FeatureSupported( TUid aFeature )

TInt RFeatureRegistry:: QuerySupport(TUid aFeatureUid, TUint32& aInfo);

TInt RFeatureControl::FeatureSupported( TFeatureEntry& aFeature )

TInt static RFeatureRegistry:: QuerySupportS(TUid aFeatureUid);

TBool static CFeatureDiscovery ::IsFeatureSupportedL( TUid aFeature )

TInt static RFeatureRegistry:: QuerySupportS(TUid aFeatureUid);

Dynamic calls to the Open(), FeatureSupported() and Close() functions of an RFeatureControl object.

TInt static RFeatureRegistry:: QuerySupportS(TUid aFeatureUid, TUint32& aInfo);

TBool static CFeatureDiscovery ::IsFeatureSupportedL( TUid aFeature )

TInt static RFeatureRegistry:: QuerySupportS(TUid aFeatureUid, TUint32& aInfo);

Dynamic calls to the Open(), FeatureSupported() and Close() functions of an RFeatureControl object.

Migrating to Feature Manager buildtime tooling

The transition from Feature Registry to Feature Manager also involves changes to the process of building ROM. Features can be included in ROM as a partial build with the purpose of upgrading features, or as the corresponding section of a full build: the changes to the procedure are the same either way.

Two tools are used to automate the process: a new version of the old tool buildrom and a new tool features.

The procedure for building ROM uses a feature database in the form of an an .xml file to specify the features to be included and an .iby file to specify those to be excluded. The structure of these files has been modified slightly.

The old feature database, called featureUIDs.xml is replaced by a new version called featuredatabase.xml with a new XML structure. The old XML tags correspond to the new ones like this.

Feature Registry Feature Manager

<features>:: uid

<feature>::uid

<features>::name

<feature>::name

None

<feature>:: statusflags

<default>:: min

<defaultfeaturerange>:: loweruid

<default>:: max

<defaultfeaturerange>:: higheruid

<default>:: support

<defaultfeaturerange>:: support

The values of the attributes are the same in both versions of the schema. The new attribute statusflags of <feature> takes the mandatory value of 0x00000001.

You can upgrade your XML feature database in three ways.

by upgrading the file manually in accordance with the equivalences given,
by calling the tool features to perform the conversion automatically, or
by leaving the file as it is and calling the tool buildrom with the flag -fm.

You call the tool features like this:

features -c <destination> featureUIDs.xml

where -c is a flag forcing the conversion. The output is a file featureUIDs_converted.xml in the folder specified at <destination>.

Whether or not you force the conversion, a call to features will generate the file feature.iby and the header file featureUIDs.h.

The .iby file, called feature.iby, has a new extended syntax. There are now two new flags which override the default values for the status flags and user-defined data:

SF followed by a value for the status flags of the feature, and
UD followed by a value for the user-defined data for the feature.

For example:

EXCLUDE_FEATURE Fax SF 0x00000008 +Migrating from Feature Registry to Feature ManagerProvides detailed instructions for migrating Feature registry to Feature Manager runtime and buildtime.

Migrating to Feature Manager runtime APIs
Migrating to Feature Manager buildtime tooling