kaa_tcp_channel.h

Go to the documentation of this file.

/*
 * Copyright 2014-2015 CyberVision, Inc.
 *
 * 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 KAA_TCP_CHANNEL_H_
#define KAA_TCP_CHANNEL_H_

#include "../kaa_error.h"
#include "../platform/ext_transport_channel.h"
#include "../platform/defaults.h"
#include "../platform/ext_tcp_utils.h"

#ifdef __cplusplus
extern "C" {
#endif


typedef enum {
    FD_READ,
    FD_WRITE,
    FD_EXCEPTION
} fd_event_t;


typedef enum {
    SOCKET_CONNECTED,
    SOCKET_DISCONNECTED,
    SOCKET_CONNECTION_ERROR
} kaa_tcp_channel_event_t;


typedef kaa_error_t (*on_kaa_tcp_channel_event_fn)(void *context
                                                 , kaa_tcp_channel_event_t event_type
                                                 , kaa_fd_t fd);


kaa_error_t kaa_tcp_channel_create(kaa_transport_channel_interface_t *self
                                 , kaa_logger_t *logger
                                 , kaa_service_t *supported_services
                                 , size_t supported_service_count);


kaa_error_t kaa_tcp_channel_get_descriptor(kaa_transport_channel_interface_t *self
                                         , kaa_fd_t *fd_p);


bool kaa_tcp_channel_is_ready(kaa_transport_channel_interface_t *self
                            , fd_event_t event_type);


kaa_error_t kaa_tcp_channel_process_event(kaa_transport_channel_interface_t *self
                                        , fd_event_t event_type);


kaa_error_t kaa_tcp_channel_get_max_timeout(kaa_transport_channel_interface_t *self
                                          , uint16_t *max_timeout);


kaa_error_t kaa_tcp_channel_check_keepalive(kaa_transport_channel_interface_t *self);


kaa_error_t kaa_tcp_channel_set_socket_events_callback(kaa_transport_channel_interface_t *self
                                                     , on_kaa_tcp_channel_event_fn callback
                                                     , void *context);


kaa_error_t kaa_tcp_channel_set_keepalive_timeout(kaa_transport_channel_interface_t *self
                                                , uint16_t keepalive);


kaa_error_t kaa_tcp_channel_disconnect(kaa_transport_channel_interface_t *self);

#ifdef __cplusplus
}      /* extern "C" */
#endif


#endif /* KAA_TCP_CHANNEL_H_ */