resource/include/CAManager.h

   1 /* ****************************************************************
   2  *
   3  * Copyright 2016 Samsung Electronics All Rights Reserved.
   4  *
   5  *
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  ******************************************************************/
  20
  21 #ifndef CA_MANAGER_H_
  22 #define CA_MANAGER_H_
  23
  24 #include <OCApi.h>
  25
  26 namespace OC
  27 {
  28     /**
  29     * This namespace contains the main entrance/functionality to monitoring network changes.
  30     * It may be used with OC::CAManager::functionName. To set a custom callback function,
  31     * the implementer must make a call to CAManager::setNetworkMonitorHandler.
  32     */
  33     namespace CAManager
  34     {
  35         // typedef to get adapter status changes from CA.
  36         typedef std::function<void(const std::string&, OCConnectivityType,
  37                                    bool)> ConnectionChangedCallback;
  38
  39         // typedef to get connection status changes from CA.
  40         typedef std::function<void(OCTransportAdapter, bool)> AdapterChangedCallback;
  41
  42         /**
  43         * Set network monitoring handler.
  44         * @param adapterHandler adapter state change handler to handle changes for
  45         *                       any transport types.
  46         * @param connectionHandler connection state change handler to handle changes for
  47         *                          connection with remote devices.
  48         * @return Returns ::OC_STACK_OK if success.
  49         */
  50         OCStackResult setNetworkMonitorHandler(AdapterChangedCallback adapterHandler,
  51                                                ConnectionChangedCallback connectionHandler);
  52
  53         /**
  54         * Set port number to use.
  55         * @param adapter transport adapter type to assign the specified port number.
  56         * @param flag transport flag information.
  57         * @param port the specified port number to use.
  58         * @return Returns ::OC_STACK_OK if success.
  59         */
  60         OCStackResult setPortNumberToAssign(OCTransportAdapter adapter,
  61                                             OCTransportFlags flag, uint16_t port);
  62
  63         /**
  64         * Get the assigned port number.
  65         * @param adapter transport adapter type to get the opened port number.
  66         * @param flag   transport flag information.
  67         * @return Returns currently assigned port number.
  68         */
  69         uint16_t getAssignedPortNumber(OCTransportAdapter adapter, OCTransportFlags flag);
  70
  71 #if defined(__WITH_DTLS__) || defined(__WITH_TLS__)
  72         /**
  73          * Select the cipher suite for TLS/DTLS handshake.
  74          * @param cipher  cipher suite (Note : Make sure endianness).
  75          *                    0x35   : TLS_RSA_WITH_AES_256_CBC_SHA
  76          *                    0xC018 : TLS_ECDH_anon_WITH_AES_128_CBC_SHA
  77          *                    0xC037 : TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
  78          *                    0xC0AE : TLS_ECDHE_ECDSA_WITH_AES_128_CCM_8
  79          * @param adapter transport adapter type.
  80          * @return Returns ::OC_STACK_OK if success.
  81          */
  82         OCStackResult setCipherSuite(const uint16_t cipher, OCTransportAdapter adapter);
  83 #endif // defined(__WITH_DTLS__) || defined(__WITH_TLS__)
  84     }
  85 }
  86
  87 #endif // CA_MANAGER_H_
  88
  89
  90