Diff: mbed-client/mbed-client/m2mconnectionhandler.h

Revision:

11:cada08fc8a70

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mbed-client/mbed-client/m2mconnectionhandler.h	Thu Jun 09 17:08:36 2016 +0000
@@ -0,0 +1,145 @@
+/*
+ * Copyright (c) 2015 ARM Limited. All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ * Licensed under the Apache License, Version 2.0 (the License); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an AS IS BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef M2M_CONNECTION_HANDLER_H__
+#define M2M_CONNECTION_HANDLER_H__
+
+#include "mbed-client/m2mconnectionobserver.h"
+#include "mbed-client/m2mconfig.h"
+#include "mbed-client/m2minterface.h"
+#include "nsdl-c/sn_nsdl.h"
+
+class M2MConnectionSecurity;
+class M2MConnectionHandlerPimpl;
+
+/**
+ * @brief M2MConnectionHandler.
+ * This class handles the socket connection for the LWM2M Client.
+ */
+
+class M2MConnectionHandler {
+public:
+
+    /**
+     * @enum ConnectionError
+     * This enum defines an error that can come from
+     * socket read and write operation.
+     */
+    typedef enum {
+        CONNECTION_ERROR_WANTS_READ = -1000,
+        CONNECTION_ERROR_WANTS_WRITE = -1001
+    }ConnectionError;
+
+public:
+
+    /**
+    * @brief Constructor
+    */
+    M2MConnectionHandler(M2MConnectionObserver &observer,
+                         M2MConnectionSecurity* sec,
+                         M2MInterface::BindingMode mode,
+                         M2MInterface::NetworkStack stack);
+
+    /**
+    * @brief Destructor
+    */
+    ~M2MConnectionHandler();
+
+    /**
+    * @brief This binds the socket connection.
+    * @param listen_port Port to be listened to for an incoming connection.
+    * @return True if successful, else false.
+    */
+    bool bind_connection(const uint16_t listen_port);
+
+    /**
+    * @brief This resolves the server address. Output is
+    * returned through a callback.
+    * @param String Server address.
+    * @param uint16_t Server port.
+    * @param ServerType, Server Type to be resolved.
+    * @param security, M2MSecurity object that determines what
+    * type of secure connection will be used by the socket.
+    * @return True if address is valid, else false.
+    */
+    bool resolve_server_address(const String& server_address,
+                                const uint16_t server_port,
+                                M2MConnectionObserver::ServerType server_type,
+                                const M2MSecurity* security);
+
+    /**
+    * @brief Sends data to the connected server.
+    * @param data_ptr, Data to be sent.
+    * @param data_len, Length of data to be sent.
+    * @param address_ptr, Address structure where data has to be sent.
+    * @return True if data is sent successfully, else false.
+    */
+    bool send_data(uint8_t *data_ptr,
+                           uint16_t data_len,
+                           sn_nsdl_addr_s *address_ptr);
+
+    /**
+    * @brief Listens to the incoming data from a remote server.
+    * @return True if successful, else false.
+    */
+    bool start_listening_for_data();
+
+    /**
+    * @brief Stops listening to the incoming data.
+    */
+    void stop_listening();
+
+    /**
+     * @brief sendToSocket Sends directly to socket. This is used by
+     * security classes to send the data after it has been encrypted.
+     * @param buf Buffer to send.
+     * @param len Length of a buffer.
+     * @return Number of bytes sent or -1 if failed.
+     */
+    int send_to_socket(const unsigned char *buf, size_t len);
+
+    /**
+     * @brief receiveFromSocket Receives directly from a socket. This
+     * is used by the security classes to receive raw data to be decrypted.
+     * @param buf Buffer to send.
+     * @param len Length of a buffer.
+     * @return Number of bytes read or -1 if failed.
+     */
+    int receive_from_socket(unsigned char *buf, size_t len);
+
+    /**
+    * @brief Closes the open connection.
+    */
+    void close_connection();
+
+    /**
+    * @brief Error handling for DTLS connectivity.
+    * @param error, Error code from TLS library
+    */
+    void handle_connection_error(int error);
+
+private:
+
+    M2MConnectionObserver                       &_observer;
+    M2MConnectionHandlerPimpl                   *_private_impl;
+
+friend class Test_M2MConnectionHandler;
+friend class Test_M2MConnectionHandler_mbed;
+friend class Test_M2MConnectionHandler_linux;
+friend class M2MConnection_TestObserver;
+};
+
+#endif //M2M_CONNECTION_HANDLER_H__
+