email/pop3andsmtpmtm/servermtmutils/inc/timmobilityaction.h
changeset 0 72b543305e3a
equal deleted inserted replaced
-1:000000000000 0:72b543305e3a
       
     1 // Copyright (c) 2006-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 "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 #ifndef __TIMMOBILITYACTION_H__
       
    17 #define __TIMMOBILITYACTION_H__
       
    18 
       
    19 /**
       
    20 Enumeration for actions that can be taken when closing existing sockets
       
    21 when accepting a migration to a new carrier.
       
    22 */
       
    23 enum TImMobilityAction
       
    24 	{
       
    25 	/**
       
    26 	KAcceptImmediately:
       
    27 	If an operation is in progress it shall be cancelled immediately. 
       
    28 	Sockets connected via the old carrier shall be closed, without 
       
    29 	first completing the session with the remote server.
       
    30 	Bearer mobility framework will be instructed to MigrateToNewCarrier().
       
    31 	Once the new connection is active, any cancelled operation shall be
       
    32 	restarted.
       
    33 	*/
       
    34 	KAcceptImmediately,
       
    35 
       
    36 	/**
       
    37 	KAcceptStopCurrent:
       
    38 	If an operation is in progress it shall be stopped at the next
       
    39 	opportunity that shall require no repeat of already completed server
       
    40 	operations that have occured in the execution of the operation up
       
    41 	to this time. This may result in a batch operation being "paused"
       
    42 	to allow the migration before it has completed.
       
    43 	Sockets connected via the old carrier shall have their sessions with
       
    44 	the remote server log out, and the socket shall be closed gracefully.
       
    45 	Bearer mobility framework will be instructed to MigrateToNewCarrier().
       
    46 	Once the new connection is active, any "paused" operation shall be
       
    47 	resumed.
       
    48 	*/
       
    49 	KAcceptStopCurrent,
       
    50 
       
    51 	/**
       
    52 	If an operation is in progress it shall be allowed to complete.
       
    53 	Sockets connected via the old carrier shall then have their sessions
       
    54 	with the remote server log out, and the socket shall be closed gracefully.
       
    55 	Bearer mobility framework will be instructed to MigrateToNewCarrier().
       
    56 	*/
       
    57 	KAcceptCompleteCurrent
       
    58 	};
       
    59 
       
    60 /**
       
    61 Enumeration describing the cause of completion of a migration handshake.
       
    62 */
       
    63 enum TImMigrateComplete
       
    64 	{
       
    65 	KImMigrateOK,
       
    66 	KImMigrateCouldNotReconnect,
       
    67 	KImMigrateMobilityError
       
    68 	};
       
    69 	
       
    70 #endif	// __TIMMOBILITYACTION_H__