epoc32/include/schsend.hrh
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) 1999-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 //
    15 
    16 #ifndef __SCHSEND_HRH__
    17 #define __SCHSEND_HRH__
    18 
    19 /** TMsvSendAction flags mask value. */
    20 #define KActionMask					0x0013
    21 /** ESendActionFail flag value. */
    22 #define KActionFail					0x0000
    23 /** ESendActionRetryImmediately flag value. */
    24 #define KActionRetryImmediately		0x0001
    25 /** ESendActionRetryLater flag value. */
    26 #define KActionRetryLater			0x0002
    27 /** ESendActionSentAlready flag value. */
    28 #define KActionSentAlready			0x0003
    29 /** ESendActionRetryConditionMet flag value. */
    30 #define KActionRetryConditionMet	0x0010
    31 
    32 /** TMsvSendRetries flags mask value. */
    33 #define KRetriesMask			0x0004
    34 /** ESendRetriesFixed flag value. */
    35 #define KRetriesFixed			0x0000
    36 /** ESendRetriesInfinite flag value. */
    37 #define KRetriesInfinite		0x0004
    38 
    39 /** TMsvSendRetrySpacing flags mask value. */
    40 #define KRetrySpacingMask		0x0008
    41 /** ESendRetrySpacingStatic flag value. */
    42 #define KRetrySpacingStatic		0x0000
    43 /** ESendRetrySpacingVariable flag value. */
    44 #define KRetrySpacingVariable	0x0008
    45 
    46 
    47 /**
    48 Defines the action to take if an error occurs in message sending.
    49 
    50 @publishedAll
    51 @released
    52 */
    53 
    54 enum TMsvSendAction
    55 	{
    56 /** Fail and do not retry. */
    57 	ESendActionFail					= KActionFail,
    58 /** Retry (after short retry interval). */
    59 	ESendActionRetryImmediately		= KActionRetryImmediately,
    60 /** Retry (after long retry interval). */
    61 	ESendActionRetryLater			= KActionRetryLater,
    62 /** Do not retry. */
    63 	ESendActionSentAlready			= KActionSentAlready,
    64 /** Retry when condition met.
    65 
    66 This is only supported in 8.1 onwards. In 8.0 this action is treated the same
    67 as ESendActionRetryImmediately.
    68  */
    69 	ESendActionRetryConditionMet	= KActionRetryConditionMet
    70 	};
    71 
    72 /**
    73 Flag that defines retry behaviour if sending a message fails.
    74 
    75 @see TMsvSendErrorAction
    76 
    77 @publishedAll
    78 @released
    79 */
    80 
    81 enum TMsvSendRetries
    82 	{
    83 /** Retry for a specified number of attempts. */
    84 	ESendRetriesFixed		= KRetriesFixed,
    85 /** Retry until successful (or the user intervenes). */
    86 	ESendRetriesInfinite		= KRetriesInfinite
    87 	};
    88 
    89 /**
    90 Flag that defines retry behaviour if sending a message fails.
    91 
    92 @see TMsvSendErrorAction
    93 
    94 @publishedAll
    95 @released
    96 */
    97 
    98 enum TMsvSendRetrySpacing
    99 	{
   100 /** Retry at fixed intervals. */
   101 	ESendRetrySpacingStatic		= KRetrySpacingStatic,
   102 /** Retry at variable intervals. */
   103 	ESendRetrySpacingVariable	= KRetrySpacingVariable
   104 	};
   105 
   106 #endif