diff -r 000000000000 -r 1bce908db942 natfw/natfwturnplugin/inc/natfwturnplugin.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/natfw/natfwturnplugin/inc/natfwturnplugin.h Tue Feb 02 01:04:58 2010 +0200 @@ -0,0 +1,214 @@ +/* +* Copyright (c) 2006 - 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: Implements NAT Plug-in interface, which client uses to send +* TURN requests. Forwards client requests to Turn Connection +* Handler. +* +*/ + + + + +#ifndef C_NATFWTURNPLUGIN_H +#define C_NATFWTURNPLUGIN_H + +#include +#include "natfwpluginapi.h" + +class CNATFWTurnConnectionHandler; + + +/** + * Implements NAT Plug-in interface + * + * The client uses this interface to send TURN requests. Forwards + * client requests to Turn Connection Handler. + * + * @lib turnplugin.lib + * @since S60 v3.2 + */ +class CNATFWTurnPlugin : public CNATFWPluginApi + { + +public: + + /** + * Creates a new instance of NAT FW TURN Plug-in class. + * + * @since S60 v3.2 + * @param aInitParams Initial parameters that will be given to + * TURN Connection Handler class. + * @return A new instance, ownership is transferred. + */ + static CNATFWTurnPlugin* NewL( TAny* aInitParams ); + + ~CNATFWTurnPlugin(); + + /** + * From CNATFWPluginApi. + * + * Finds out a STUN Server and establishes a connection to it. + * + * MNATFWPluginObserver::Notify is called with event code EServerConnected + * when connecting has completed. + * + * FetchCandidateL can be called after successful connecting. + * + * @since S60 v3.2 + * @param aSocketServ The handle to socket server session + * @param aConnectionName The unique name of the RConnection + */ + void ConnectServerL( const RSocketServ& aSocketServ, + const TName& aConnectionName ); + + /** + * From CNATFWPluginApi. + * + * Fetches available candidates for a specified stream using given + * retransmission timeout for STUN transactions. + * + * RTO value 0 indicates default retransmission timeout as specified + * in STUN specification. + * + * @since S60 v3.2 + * @param aStreamId Stream identifier + * @param aRtoValue Retransmission timeout in milliseconds + * @param aAddrFamily KAFUnspec / KAfInet / KAfInet6 + * @leave KErrNotSupported NAT Protocol plugin does not support + * operation. + */ + void FetchCandidateL( TUint aStreamId, TUint aRtoValue, + TUint aAddrFamily ); + + /** + * From CNATFWPluginApi. + * + * Fetches available candidates for a specified stream using given + * retransmission timeout for STUN transactions. + * + * RTO value 0 indicates default retransmission timeout as specified + * in STUN specification. + * + * Candidate is fetched using given base address as a local endpoint for + * a multiplexer connection. + * + * @since S60 v3.2 + * @param aStreamId Stream identifier + * @param aRtoValue Retransmission timeout in milliseconds + * @param aBaseAddr Address from which to create connection + */ + void FetchCandidateL( TUint aStreamId, TUint aRtoValue, + const TInetAddr& aBaseAddr ); + + /** + * From CNATFWPluginApi. + * + * Enables/disables media receiving for the specified local candidate. + * + * Only those candidates given with MNATFWPluginObserver callbacks + * can be controlled. NATFW stream can have only one active candidate + * at a time. In other words, exactly one local candidate can be used + * for media delivery in receiving, sending or both directions. + * + * MNATFWPluginObserver::Notify is called with event code + * EReceivingActivated/EReceivingDeactivated when status change has + * completed. While activated incoming data is delivered to the media + * engine. + * + * Receiving must be disabled prior to deleting plugin so that all + * resources can be freed. + * + * Note: If TURN is used media cannot be delivered until remote address + * is known. + * + * @since S60 v3.2 + * @pre FetchCandidate(/s) and possible ICE processing have completed + * @param aLocalCandidate The local end point for a media + * @param aState The receiving state + */ + void SetReceivingStateL( const CNATFWCandidate& aLocalCandidate, + TNATFWStreamingState aState ); + + /** + * From CNATFWPluginApi. + * + * Enables/disables media sending from the specified local candidate. + * + * Only those candidates given with MNATFWPluginObserver callbacks + * can be controlled. NATFW stream can have only one active candidate + * at a time. In other words, exactly one local candidate can be used + * for media delivery in receiving, sending or both directions. + * + * Sending must be disabled prior to deleting plugin so that all + * resources can be freed. + * + * MNATFWPluginObserver::Notify is called with event code + * ESendingActivated/ESendingDeactivated when status change has + * completed. While activated outgoing data from media engine is delivered + * to the specified remote address. + * + * @since S60 v3.2 + * @pre FetchCandidate(/s) and possible ICE processing have completed + * @param aLocalCandidate The local end point for a media + * @param aState The sending state + * @param aDestAddr The remote end point for a media + */ + void SetSendingStateL( const CNATFWCandidate& aLocalCandidate, + TNATFWStreamingState aState, const TInetAddr& aDestAddr ); + + /** + * From CNATFWPluginApi. + * + * Gets identifier for a connection that is associated with the + * given local end point. + * + * @since S60 v3.2 + * @param aLocalCandidate The local end point for a media + * @param aConnectionId Reference to found id + */ + void GetConnectionIdL( const CNATFWCandidate& aLocalCandidate, + TUint& aConnectionId ); + + /** + * From CNATFWPluginApi. + * Get identifier of the plugin. + * + * @since S60 3.2 + * @return Identifier of the plugin + */ + const TDesC8& PluginIdentifier() const; + +private: + + CNATFWTurnPlugin(); + + void ConstructL( TAny* aInitParams ); + +private: // data + + /** + * Plugin identifier. + * Own. + */ + HBufC8* iPluginId; + + /** + * Handles connection related actions. + * Own. + */ + CNATFWTurnConnectionHandler* iTurnConnectionHandler; + + }; + +#endif // C_NATFWTURNPLUGIN_H