epoc32/include/mbmstypes.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 // Common MBMS Broadcast Variables
    15 // 
    16 //
    17 
    18 
    19 
    20 /**
    21  @file
    22  @publishedAll
    23  @released
    24 */
    25 
    26 #ifndef _MBMSTYPES_H_
    27 #define _MBMSTYPES_H_
    28 
    29 /**
    30  * This name will be used by the TSY to identify the request for MBMS context
    31  *
    32  * @publishedPartner
    33  * @released
    34  */
    35 _LIT(KMBMSContextName,"MBMS_CONTEXT");
    36 
    37 /**
    38  * Holds the list of MBMS sessions identifiers
    39  */
    40 typedef RArray<TUint> TMbmsSessionIdList;
    41 
    42 /**
    43  * Holds the MBMS session identifier
    44  */
    45 typedef TUint TMbmsSessionId;
    46 
    47 class TTmgi 
    48 /** 
    49  * Holds the Temporary mobile group identity information
    50  * @see section 15.2 of 3GPP TS 23.007
    51  */
    52 	{
    53 public:
    54 	inline TUint GetServiceId() const	{ return iServiceID; }
    55 	inline void SetServiceId(TUint aServiceID)	{ iServiceID = aServiceID; }
    56 	inline TUint16 GetMCC() const	{ return iMCC; }
    57 	inline void SetMCC(TUint16 aMCC) 	{ iMCC = aMCC; }
    58 	inline TUint16 GetMNC() const { return iMNC; }
    59 	inline void SetMNC(TUint16 aMNC)	{ iMNC=aMNC; }
    60 
    61 private:
    62 	/** MBMS Service ID uniquely identifies an MBMS bearer service within a PLMN. */	
    63 	TUint iServiceID;
    64 	/** Mobile Country Code Information */	
    65 	TUint16 iMCC;
    66 	/** Mobile Network Code Information */	
    67 	TUint16 iMNC;
    68 	};
    69 	
    70 /** 
    71  * Holds the MBMS Access Bearer Information. 
    72  */
    73 enum TMbmsScope
    74 	{
    75 	/** MBMS Bearer is 2G. */	
    76 	E2GBearer,
    77 	/** MBMS Bearer is 3G. */	
    78 	E3GBearer			
    79 	};
    80 
    81 	
    82 /** 
    83  * Holds the MBMS Service priority Information
    84  */
    85 enum TMbmsServicePriority
    86 	{
    87 	/** Emergency MBMS service priority. */	
    88 	EMbmsEmergencyServicePriority, 
    89 	/** High MBMS service priority. */
    90 	EMbmsHighServicePriority,
    91 	/** Medium MBMS service priority. */
    92 	EMbmsMediumServicePriority,
    93 	/** Lowest MBMS service priority. */
    94 	EMbmsLowServicePriority
    95 	};
    96 	
    97 /** 
    98  * Holds the MBMS Service mode Information
    99  */
   100 enum TMbmsServiceMode
   101 	{
   102 	/** MBMS broadcast service mode. */
   103 	KBroadcast = 0x01,
   104 	/** MBMS Selected Broadcast mode. */
   105 	KSelectedBroadcast = 0x02
   106 	};
   107 	
   108 /** 
   109  * Holds the MBMS service availability status Information 
   110  */
   111 enum TMbmsAvailabilityStatus
   112 	{
   113 	/** MBMS availability status is unknown. */
   114 	EMbmsAvailabilityUnknown,
   115 	/** MBMS availability status is unavailable. */
   116 	EMbmsUnavailable,
   117 	/** MBMS availability status is available. */
   118 	EMbmsAvailable
   119 	};
   120 
   121 /** 
   122  * Holds the MBMS Network service status Information 
   123  */
   124 enum TMbmsNetworkServiceStatus
   125 	{
   126 	/** MBMS Network status is unknown. */
   127 	EMbmsSupportUnknown,
   128 	/** MBMS Network status is supported. */
   129 	EMbmsSupported,
   130 	/** MBMS Network status is not supported. */
   131 	EMbmsNotSupported
   132 	};
   133 
   134 /** 
   135  * Holds the Different MBMS Action Information 
   136  */
   137 enum TMbmsAction
   138 	{
   139 	/** Add the mbms entries. */ 
   140 	EAddEntries,
   141 	/** Removes the mbms entries. */ 
   142 	ERemoveEntries,
   143 	/** Removes all the mbms entries. */ 
   144 	ERemoveAllEntries
   145 	};
   146 	
   147 #endif