epoc32/include/schsend.hrh
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
// Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __SCHSEND_HRH__
williamr@2
    17
#define __SCHSEND_HRH__
williamr@2
    18
williamr@2
    19
/** TMsvSendAction flags mask value. */
williamr@2
    20
#define KActionMask					0x0013
williamr@2
    21
/** ESendActionFail flag value. */
williamr@2
    22
#define KActionFail					0x0000
williamr@2
    23
/** ESendActionRetryImmediately flag value. */
williamr@2
    24
#define KActionRetryImmediately		0x0001
williamr@2
    25
/** ESendActionRetryLater flag value. */
williamr@2
    26
#define KActionRetryLater			0x0002
williamr@2
    27
/** ESendActionSentAlready flag value. */
williamr@2
    28
#define KActionSentAlready			0x0003
williamr@2
    29
/** ESendActionRetryConditionMet flag value. */
williamr@2
    30
#define KActionRetryConditionMet	0x0010
williamr@2
    31
williamr@2
    32
/** TMsvSendRetries flags mask value. */
williamr@2
    33
#define KRetriesMask			0x0004
williamr@2
    34
/** ESendRetriesFixed flag value. */
williamr@2
    35
#define KRetriesFixed			0x0000
williamr@2
    36
/** ESendRetriesInfinite flag value. */
williamr@2
    37
#define KRetriesInfinite		0x0004
williamr@2
    38
williamr@2
    39
/** TMsvSendRetrySpacing flags mask value. */
williamr@2
    40
#define KRetrySpacingMask		0x0008
williamr@2
    41
/** ESendRetrySpacingStatic flag value. */
williamr@2
    42
#define KRetrySpacingStatic		0x0000
williamr@2
    43
/** ESendRetrySpacingVariable flag value. */
williamr@2
    44
#define KRetrySpacingVariable	0x0008
williamr@2
    45
williamr@2
    46
williamr@2
    47
/**
williamr@2
    48
Defines the action to take if an error occurs in message sending.
williamr@2
    49
williamr@2
    50
@publishedAll
williamr@2
    51
@released
williamr@2
    52
*/
williamr@2
    53
williamr@2
    54
enum TMsvSendAction
williamr@2
    55
	{
williamr@2
    56
/** Fail and do not retry. */
williamr@2
    57
	ESendActionFail					= KActionFail,
williamr@2
    58
/** Retry (after short retry interval). */
williamr@2
    59
	ESendActionRetryImmediately		= KActionRetryImmediately,
williamr@2
    60
/** Retry (after long retry interval). */
williamr@2
    61
	ESendActionRetryLater			= KActionRetryLater,
williamr@2
    62
/** Do not retry. */
williamr@2
    63
	ESendActionSentAlready			= KActionSentAlready,
williamr@2
    64
/** Retry when condition met.
williamr@2
    65
williamr@2
    66
This is only supported in 8.1 onwards. In 8.0 this action is treated the same
williamr@2
    67
as ESendActionRetryImmediately.
williamr@2
    68
 */
williamr@2
    69
	ESendActionRetryConditionMet	= KActionRetryConditionMet
williamr@2
    70
	};
williamr@2
    71
williamr@2
    72
/**
williamr@2
    73
Flag that defines retry behaviour if sending a message fails.
williamr@2
    74
williamr@2
    75
@see TMsvSendErrorAction
williamr@2
    76
williamr@2
    77
@publishedAll
williamr@2
    78
@released
williamr@2
    79
*/
williamr@2
    80
williamr@2
    81
enum TMsvSendRetries
williamr@2
    82
	{
williamr@2
    83
/** Retry for a specified number of attempts. */
williamr@2
    84
	ESendRetriesFixed		= KRetriesFixed,
williamr@2
    85
/** Retry until successful (or the user intervenes). */
williamr@2
    86
	ESendRetriesInfinite		= KRetriesInfinite
williamr@2
    87
	};
williamr@2
    88
williamr@2
    89
/**
williamr@2
    90
Flag that defines retry behaviour if sending a message fails.
williamr@2
    91
williamr@2
    92
@see TMsvSendErrorAction
williamr@2
    93
williamr@2
    94
@publishedAll
williamr@2
    95
@released
williamr@2
    96
*/
williamr@2
    97
williamr@2
    98
enum TMsvSendRetrySpacing
williamr@2
    99
	{
williamr@2
   100
/** Retry at fixed intervals. */
williamr@2
   101
	ESendRetrySpacingStatic		= KRetrySpacingStatic,
williamr@2
   102
/** Retry at variable intervals. */
williamr@2
   103
	ESendRetrySpacingVariable	= KRetrySpacingVariable
williamr@2
   104
	};
williamr@2
   105
williamr@2
   106
#endif