socket.h (r4203/r3618)

Go to the documentation of this file.

/*
 * $Id: socket.h 3618 2006-11-02 17:08:30Z riedel $
 * Copyright (c) 2004
 * Telecooperation Office (TecO), Universitaet Karlsruhe (TH), Germany.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials provided
 *    with the distribution.
 * 3. Neither the name of the Universitaet Karlsruhe (TH) nor the names
 *    of its contributors may be used to endorse or promote products
 *    derived from this software without specific prior written
 *    permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Author(s): Max Laier <mlaier@freebsd.org>
 *                        Thomas Morper <morper@teco.edu>
 */

#ifndef _SOCKET_H_
#define _SOCKET_H_

#include "conf.h"
#include "socket_enum.h"

LIBPARTICLE_API int p_socket_open(uint32_t localip, uint32_t broadcast_add, int port);

LIBPARTICLE_API int p_socket_close(int sock);

LIBPARTICLE_API int p_socket_set_lastacks(int counter);

LIBPARTICLE_API int p_socket_set_lastdups(int counter);

LIBPARTICLE_API int p_socket_set_ipdest(int sock, const struct in_addr * address);

LIBPARTICLE_API int p_socket_set_ipdest_str(int sock, const char * address);

LIBPARTICLE_API int p_socket_set_ipdest_all(int fd);

LIBPARTICLE_API int p_socket_set_ipsrc_all(int sock);

LIBPARTICLE_API int p_socket_set_ipsrc(int sock, const struct in_addr * address);

LIBPARTICLE_API int p_socket_set_ipsrc_str(int sock     , const char * address);

LIBPARTICLE_API int p_socket_set_id(int sock, const uint8_t * add);

LIBPARTICLE_API int p_socket_set_id_str(int sock, const char * addstr);

LIBPARTICLE_API int p_socket_set_loc(int sock, const uint8_t * loc);

LIBPARTICLE_API int p_socket_set_loc_str(int sock, const char * locstr);

LIBPARTICLE_API int p_socket_set_option(int fd, int option, int mode);

LIBPARTICLE_API int p_socket_set_retry(int sock, uint8_t retries, uint32_t timeout);

LIBPARTICLE_API void p_describe_socket(int sock);

LIBPARTICLE_API int p_socket_get_lastacks(void);


LIBPARTICLE_API uint8_t* p_socket_get_id(int fd);

LIBPARTICLE_API uint8_t* p_socket_get_loc(int fd);

LIBPARTICLE_API uint8_t * p_socket_get_ipdest(int fd, int device_number);

LIBPARTICLE_API int p_socket_get_num_interfaces(int fd);

LIBPARTICLE_API int p_socket_set_num_interfaces(int fd, int counter);

LIBPARTICLE_API uint8_t * p_socket_get_ipsrc(int fd);

LIBPARTICLE_API int p_socket_get_retry(int fd);

LIBPARTICLE_API uint32_t p_socket_get_timeout(int fd);

LIBPARTICLE_API uint16_t p_socket_get_port(int fd);

LIBPARTICLE_API int p_socket_get_option(int fd, int option);

LIBPARTICLE_API int p_socket_get_blocking(int fd);

LIBPARTICLE_API int p_socket_get_broadcast(int fd);

LIBPARTICLE_API uint8_t p_socket_get_last_seq(int fd);

/*
 * END: SOCKET ABSTRACTION
 */

/*
 * BEGIN: RECEIVE DATA
 */

LIBPARTICLE_API struct p_packet *p_socket_recv(int recv_sock, int send_sock);


LIBPARTICLE_API struct p_packet *p_socket_recv_filtered(int recv_sock, int send_sock, int recv_filter);

LIBPARTICLE_API int p_socket_recv_raw(int sock, char * data, size_t maxlen);

struct timeval;
LIBPARTICLE_API int p_socket_select(int fd, uint16_t milliseconds);

/*
 * END: RECEIVE DATA
 */

/*
 * BEGIN: SEND DATA
 */

LIBPARTICLE_API int p_socket_send(int send_sock, struct p_packet * send_data);

LIBPARTICLE_API int p_socket_send_addressed(int send_sock, struct p_packet * send_data, uint8_t * add);

LIBPARTICLE_API int p_socket_send_addressed_str(int send_sock, struct p_packet * send_data, const char * add_str);

LIBPARTICLE_API int p_socket_send_acked(int send_sock, int recv_sock, struct p_packet * send_data, const uint8_t * add);


LIBPARTICLE_API int p_socket_send_acked_str(int send_sock, int recv_sock, struct p_packet * send_data, const char * addstr);

LIBPARTICLE_API int p_socket_send_buffer(int fd_out, int fd_in, const char * buf, uint32_t len, const uint8_t * sendto, const uint8_t * acl_type);

LIBPARTICLE_API int p_socket_send_buffer_str(int fd_out, int fd_in, const char * buf, uint32_t len, const char * sendto, const char * acl_type);

LIBPARTICLE_API int p_socket_send_file(int fd_out, int fd_in, const char * filename, const uint8_t * sendto, const uint8_t * acl_type);

LIBPARTICLE_API int p_socket_send_raw(int sock, const char * data, size_t len);

LIBPARTICLE_API int p_socket_get_send_status(int sendticket);

LIBPARTICLE_API int p_socket_delete_send_context(int sendticket);

/*
 * END: SEND DATA
 */

/*
 * Begin: Old functions...
 */

int p_socket_set_broadcast();

int p_socket_set_blocking();

int p_socket_set_autoack();

int p_socket_set_recv_option();

int p_socket_set_frag_option();

/*
 * end: Old functions
 */

#endif /* _SOCKET_H_ */

---