m2mconnectionhandler.h

Go to the documentation of this file.

/*
 * 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;

class M2MConnectionHandler {
public:

    typedef enum {
        ERROR_NONE = 0,
        ERROR_GENERIC = -1,
        CONNECTION_ERROR_WANTS_READ = -2,
        CONNECTION_ERROR_WANTS_WRITE = -3,
        SSL_PEER_CLOSE_NOTIFY = -4,
        MEMORY_ALLOCATION_FAILED = -5,
        SSL_CONNECTION_ERROR = -6,
        SOCKET_READ_ERROR = -7,
        SOCKET_SEND_ERROR = -8,
        SOCKET_ABORT = -9,
        DNS_RESOLVING_ERROR = -10,
        SSL_HANDSHAKE_ERROR = -11,
        FAILED_TO_READ_CREDENTIALS = -12,
        SOCKET_TIMEOUT = -13,
    } ConnectionError;

    typedef enum {
        DEFAULT_PRIORITY = 0,
        HIGH_PRIORITY = 10,
        ALERT_PRIORITY = 46
    } SocketPriority;

public:

    M2MConnectionHandler(M2MConnectionObserver &observer,
                         M2MConnectionSecurity *sec,
                         M2MInterface::BindingMode mode,
                         M2MInterface::NetworkStack stack);

    ~M2MConnectionHandler();

    bool bind_connection(const uint16_t listen_port);

    bool resolve_server_address(const String &server_address,
                                const uint16_t server_port,
                                M2MConnectionObserver::ServerType server_type,
                                const M2MSecurity *security,
                                bool is_server_ping = false);

    bool send_data(uint8_t *data_ptr,
                   uint16_t data_len,
                   sn_nsdl_addr_s *address_ptr);

    bool start_listening_for_data();

    void stop_listening();

    void force_close();

    void handle_connection_error(int error);

    void set_platform_network_handler(void *handler = NULL);

    void claim_mutex();

    void release_mutex();

    void unregister_network_handler();

    bool set_socket_priority(M2MConnectionHandler::SocketPriority priority);

    void store_cid();

    void remove_cid();

    bool is_cid_available();

    void set_cid_value(const uint8_t *data_ptr, const size_t data_len);

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__