--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/natfw/natfwturnplugin/inc/tturnplugincallbackinfo.h Tue Feb 02 01:04:58 2010 +0200
@@ -0,0 +1,156 @@
+/*
+* Copyright (c) 2007 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:
+*
+*/
+
+
+
+
+#ifndef T_TURNPLUGINCALLBACKINFO_H
+#define T_TURNPLUGINCALLBACKINFO_H
+
+// INCLUDES
+#include <e32base.h>
+#include "mnatfwpluginobserver.h"
+
+
+/**
+ * This class contains the information to execute a single callback
+ * function of MNATFWPluginObserver.
+ */
+class TTurnPluginCallbackInfo
+ {
+public: // Enumerations
+
+ /**
+ * One entry for each function of MNATFWPluginObserver, including all
+ * the different TNATFWPluginEvent values. In addition error value,
+ * for error notifications.
+ */
+ enum TFunction
+ {
+ EConnectServer,
+ EActiveSending,
+ EDeactiveSending,
+ EActiveReceiving,
+ EDeactiveReceiving,
+ ELocalCandidateFound,
+ EFetchingEnd,
+ EError
+ };
+
+public: // Constructors and destructor
+
+ /**
+ * Constructor
+ *
+ * @since S60 3.2
+ * @param aTurnPlugin TURN Plug-in instance
+ * @param aObserver TURN Plug-in observer
+ * @param aFunction Identifies the function of MNATFWPluginObserver
+ * to be called
+ * @param aStreamId stream ID
+ * @param aErrorCode Error reason
+ * @param aEventData Event data if any
+ */
+ TTurnPluginCallbackInfo( const CNATFWPluginApi& aTurnPlugin,
+ MNATFWPluginObserver& aObserver,
+ TTurnPluginCallbackInfo::TFunction aFunction,
+ TUint aStreamId,
+ TInt aErrorCode,
+ TAny* aEventData );
+
+ /**
+ * Checks that the selected callback function has required parameters
+ * defined and that no unrelevant parameters have been specified.
+ *
+ * @since S60 3.2
+ * @return result of validation process as a boolean type
+ */
+ TBool Validate() const;
+
+ /**
+ * Calls a selected function of observer with the given parameters.
+ * The function to call and the parameters were specified in the
+ * constructor.
+ *
+ * @since S60 v3.2
+ */
+ void Execute() const;
+
+private: // Constructors, for internal use
+
+ TTurnPluginCallbackInfo();
+
+ TTurnPluginCallbackInfo( const TTurnPluginCallbackInfo& aCallbackInfo );
+
+private: // New functions, for internal use
+
+ /**
+ * Passes events to observer
+ *
+ * @since S60 3.2
+ * @param aEvent plug-in event
+ */
+ void PassEvent(
+ MNATFWPluginObserver::TNATFWPluginEvent aEvent ) const;
+
+ /**
+ * Passes errors to observer
+ *
+ * @since S60 v3.2
+ */
+ void PassError() const;
+
+public: // Data
+
+ /**
+ * Que link
+ */
+ TSglQueLink iLink;
+
+ /**
+ * TURN Plug-in reference
+ */
+ const CNATFWPluginApi& iTurnPlugin;
+
+ /**
+ * Observer for which to pass events
+ */
+ MNATFWPluginObserver& iObserver;
+
+ /**
+ * Selected callback function
+ */
+ TTurnPluginCallbackInfo::TFunction iFunction;
+
+ /**
+ * Stream ID
+ */
+ TUint iStreamId;
+
+ /**
+ * Error code
+ */
+ TInt iErrorCode;
+
+ /**
+ * The event data
+ */
+ TAny* iEventData;
+ };
+
+#endif // T_TURNPLUGINCALLBACKINFO_H
+