// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// under the terms of "Eclipse Public License v1.0"
// which accompanies this distribution, and is available
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
// THIS API IS INTERNAL TO NETWORKING AND IS SUBJECT TO CHANGE AND NOT FOR EXTERNAL USE
// 
//

/**
 @file
 @internalAll
*/

#ifndef SYMBIAN_NODEMESSAGES_FLOW_H
#define SYMBIAN_NODEMESSAGES_FLOW_H

namespace ESock
{

//any new enum added here needs to go into one of the utracedecoder definition files
//NEVER INSERT ANYTHING IN HERE ONLY ADD THE PENALTY IS SUDDEN DEATH!
class TCFFlow : public TCFDataClient
	{
private:
	enum
	{
	ECFRejoin                       = 1,
 	ECFBlock                        = 2,
 	ECFUnBlock                      = 3
	};

protected:
	TCFControlProvider& iControlProvider;

public:
    enum { ERealmId = 0x10285F45 }; //UID allocated on 4/6/08 from KUidNodeMessageRealms
    /*==========================================================================
    <<Keys:>>
    [Name]:      <messagename>
    [Semantics]: Message semantics

    [Type]:      Request for <responsemsg>|Response to <requestmsg>|Notification/[Peerless]
                 Where:
                 Request      - request to perform an action. Sender should expect <responsemsg>
                                to ackowledge the completion of the action.
                 Response     - acknowledgement that the previous request is now completed.
                 Notification - a one-off message flagging an event.
                 Peerless     - the message is peerless, i.e.: the sender doesn't have to
                                be the recipient's client.
    [Fallible]:  Yes|No
                 Only applicable to requests and denotes whether the request can fail or not,
                 or, in other words, whether the request can be completed to with TError.

    [Structure]:
    Every message defined in this realm has at least:
    param        iSender      - the message sender
    param        iActivityId  - depending on the message type:
                 Request      - the activity id the response should be addressed to.
                                Request senders fill up this param to match the response
                                with the local activity. Activity id on the sender side
                                should uniquelly identify the activity expecting the response.
                 Response     - the activity on the recipient side expecting this response.
                                the activityid to put here has been previously conveyed
                                with the request.
                 Notification - ignored.
    ===========================================================================*/

    /*==========================================================================
    [Name]:      TRejoin
    [Semantics]: Notification about a new control provider. Existing control provider has
                 typically migrated the recipient to a new control provider. The recpient
                 should quietly change its control provider reference.

    [Type]:      Notification

    [Structure]:
    param:       iNodeId - the new control provider.
    ===========================================================================*/
    typedef Messages::TMessageSigNodeId<ECFRejoin, TCFFlow::ERealmId> TRejoin;

    /*==========================================================================
    [Name]:      TBlock
    [Semantics]: Flow control. Sent to a dataclient to request a temporary stop.
                 Dataclients performs best effort flow control. This is NOT SUPPORTED
                 as standard, please check the approprate flow before using this messsage

    [Type]:      Notification.
    [Fallible]:  No.

    [Structure]:
    ===========================================================================*/
    typedef Messages::TMessageSigVoid<ECFBlock, TCFFlow::ERealmId> TBlock;

    /*==========================================================================
    [Name]:      TUnBlock
    [Semantics]: Flow control. Opposite of TBlock. Again this is NOT SUPPORTED
    			 as standard by all flows.

    [Type]:      Notification.
    [Fallible]:  No.

    [Structure]:
    ===========================================================================*/
    typedef Messages::TMessageSigVoid<ECFUnBlock, TCFFlow::ERealmId> TUnBlock;
	};

} //namespace esock

#endif
//SYMBIAN_NODEMESSAGES_FLOW_H