ext_tcp_utils.h

Go to the documentation of this file.

/*
 * Copyright 2014-2016 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 EXT_TCP_UTILS_H_
#define EXT_TCP_UTILS_H_

#include <platform/sock.h>
#include "kaa_error.h"

#ifdef __cplusplus
extern "C" {
#endif

#define KAA_TCP_SOCKET_NOT_SET -1


typedef enum {
    RET_STATE_VALUE_ERROR = 0,
    RET_STATE_BUFFER_NOT_ENOUGH,
    RET_STATE_VALUE_READY,
    RET_STATE_VALUE_IN_PROGRESS
} ext_tcp_utils_function_return_state_t;


typedef enum {
    KAA_TCP_SOCK_ERROR = 0,
    KAA_TCP_SOCK_CONNECTING,
    KAA_TCP_SOCK_CONNECTED
} ext_tcp_socket_state_t;


typedef enum {
    KAA_TCP_SOCK_IO_OK = 0,
    KAA_TCP_SOCK_IO_EOF,
    KAA_TCP_SOCK_IO_ERROR
} ext_tcp_socket_io_errors_t;


typedef kaa_error_t (*on_dns_resolve_complete_fn)(void *context
                                                , const kaa_sockaddr_t *addr
                                                , kaa_socklen_t addr_size);


typedef kaa_error_t (*on_dns_resolve_failed_fn)(void *context);


typedef struct {
    void                       *context;             
    on_dns_resolve_complete_fn  on_host_resolved;    
    on_dns_resolve_failed_fn    on_resolve_failed;   
} kaa_dns_resolve_listener_t;


typedef struct {
    char    *hostname;               
    size_t   hostname_length;        
    uint16_t port;                   
} kaa_dns_resolve_info_t;


ext_tcp_utils_function_return_state_t ext_tcp_utils_getaddrbyhost(kaa_dns_resolve_listener_t *resolve_listener
                                                                , const kaa_dns_resolve_info_t *resolve_props
                                                                , kaa_sockaddr_t *result
                                                                , kaa_socklen_t *result_size);


kaa_error_t ext_tcp_utils_set_sockaddr_port(kaa_sockaddr_t *addr, uint16_t port);


kaa_error_t ext_tcp_utils_open_tcp_socket(kaa_fd_t *fd
                                        , const kaa_sockaddr_t *destination
                                        , kaa_socklen_t destination_size);


ext_tcp_socket_state_t ext_tcp_utils_tcp_socket_check(kaa_fd_t fd
                                                    , const kaa_sockaddr_t *destination
                                                    , kaa_socklen_t destination_size);


ext_tcp_socket_io_errors_t ext_tcp_utils_tcp_socket_write(kaa_fd_t fd
                                                        , const char *buffer
                                                        , size_t buffer_size
                                                        , size_t *bytes_written);


ext_tcp_socket_io_errors_t ext_tcp_utils_tcp_socket_read(kaa_fd_t fd
                                                       , char *buffer
                                                       , size_t buffer_size
                                                       , size_t *bytes_read);


kaa_error_t ext_tcp_utils_tcp_socket_close(kaa_fd_t fd);

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


#endif /* EXT_TCP_UTILS_H_ */