inc/FNetILocalDhcpServerEventListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 /**
  19  * @file        FNetILocalDhcpServerEventListener.h
  20  * @brief       This is the header file for the %ILocalDhcpServerEventListener interface.
  21  *
  22  * This header file contains the declarations of the %ILocalDhcpServerEventListener interface.
  23  *
  24  */
  25 #ifndef _FNET_ILOCAL_DHCP_SERVER_EVENT_LISTENER_H_
  26 #define _FNET_ILOCAL_DHCP_SERVER_EVENT_LISTENER_H_
  27
  28 #include <FBaseRtIEventListener.h>
  29
  30 namespace Tizen { namespace Net
  31 {
  32 class LocalDhcpServer;
  33 class DhcpClientInfo;
  34 /**
  35  * @interface   ILocalDhcpServerEventListener
  36  * @brief               This interface defines the listeners for the local DHCP server events.
  37  *
  38  * @since               2.0
  39  *
  40  * The %ILocalDhcpServerEventListener interface provides methods for creating notifications about the different kinds of DHCP server events.
  41  * These events are only sent out when %ILocalDhcpServerEventListener is added to a LocalDhcpServer instance, by invoking the
  42  * SetLocalDhcpServerEventListener() method. When a %LocalDhcpServer event is generated, one of these methods is called. The methods of this
  43  * interface may be overridden and used in any application that uses the local DHCP server.
  44  *
  45  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/net/local_DHCP_server_access.htm">Local DHCP Server Access</a>.
  46  *
  47  * @see DhcpClientInfo
  48  */
  49 class _OSP_EXPORT_ ILocalDhcpServerEventListener
  50         : virtual public Tizen::Base::Runtime::IEventListener
  51 {
  52 public:
  53         /** This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
  54          *
  55          * @since 2.0
  56          */
  57         virtual ~ILocalDhcpServerEventListener(void) {}
  58
  59 public:
  60         /**
  61          * Called to notify the application that the client network connection on the local DHCP server has been connected.
  62          *
  63          * @since       2.0
  64          *
  65          * @param[in]   localDhcpServer         The requested local DHCP server
  66          * @param[in]   dhcpClientInfo          The connected client information on the local DHCP server event
  67          */
  68         virtual void OnDhcpClientConnectedN(LocalDhcpServer& localDhcpServer, DhcpClientInfo& dhcpClientInfo) = 0;
  69
  70         /**
  71          * Called to notify the application that the client network connection on the local DHCP server has been disconnected.
  72          *
  73          * @since       2.0
  74          *
  75          * @param[in]   localDhcpServer         The requested local DHCP server
  76          * @param[in]   dhcpClientInfo          The disconnected client information on the local DHCP server event
  77          */
  78         virtual void OnDhcpClientDisconnectedN(LocalDhcpServer& localDhcpServer, DhcpClientInfo& dhcpClientInfo) = 0;
  79
  80 protected:
  81         // Reserved virtual methods for later extension.
  82
  83         //
  84         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  85         //
  86         // This method is reserved and may change its name at any time without prior notice.
  87         //
  88         // @since       2.0
  89         //
  90         virtual void ILocalDhcpServerEventListener_Reserved1(void) {}
  91
  92         //
  93         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  94         //
  95         // This method is reserved and may change its name at any time without prior notice.
  96         //
  97         // @since       2.0
  98         //
  99         virtual void ILocalDhcpServerEventListener_Reserved2(void) {}
 100
 101         //
 102         // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 103         //
 104         // This method is reserved and may change its name at any time without prior notice.
 105         //
 106         // @since       2.0
 107         //
 108         virtual void ILocalDhcpServerEventListener_Reserved3(void) {}
 109 }; // ILocalDhcpServerEventListener
 110
 111 } } // Tizen::Net
 112
 113 #endif // _FNET_ILOCAL_DHCP_SERVER_EVENT_LISTENER_H_