packet.h (r4203/r3401)

Go to the documentation of this file.

/*
 * $Id: packet.h 3401 2006-09-15 08:19:19Z 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>
 */

#include <sys/types.h>
#ifndef _PACKET_H_
#define _PACKET_H_

LIBPARTICLE_API struct p_packet *p_pkt_alloc(void);

LIBPARTICLE_API struct p_packet *p_pkt_dup(const struct p_packet *packet);

LIBPARTICLE_API int p_pkt_free(struct p_packet * packet);

LIBPARTICLE_API int p_pkt_parse(struct p_packet *packet, const char *data, size_t len);

LIBPARTICLE_API const uint8_t *p_pkt_get_location(const struct p_packet * packet);

LIBPARTICLE_API const uint8_t *p_pkt_get_srcid(const struct p_packet * packet);

LIBPARTICLE_API uint8_t  p_pkt_get_seq(const struct p_packet * packet);

LIBPARTICLE_API int p_pkt_get_ack(const struct p_packet * packet);

LIBPARTICLE_API size_t p_pkt_get_payload_length(struct p_packet *packet);

LIBPARTICLE_API char *p_pkt_get_location_str(const struct p_packet * packet, char * buffer, size_t maxlen);

LIBPARTICLE_API char *p_pkt_get_srcid_str(const struct p_packet * packet, char * buffer, size_t maxlen);

LIBPARTICLE_API int p_pkt_set_location(struct p_packet * packet, const uint8_t * location);

LIBPARTICLE_API int p_pkt_set_srcid(struct p_packet * packet, const uint8_t * source);

LIBPARTICLE_API int p_pkt_set_seq(struct p_packet * packet, const uint8_t seq);

LIBPARTICLE_API int p_pkt_set_location_str(struct p_packet * packet, const char * location);

LIBPARTICLE_API int p_pkt_set_srcid_str(struct p_packet * packet, const char * source);

LIBPARTICLE_API void p_describe_pkt(const struct p_packet * packet);

LIBPARTICLE_API char * p_pkt_get_payload(const struct p_packet *pkt, char *buf, size_t *len);

LIBPARTICLE_API int p_pkt_set_payload(struct p_packet *pkt, const char *data, size_t len);

/* 
 * @{*/
struct p_acl_tuple;
LIBPARTICLE_API struct p_acl_tuple *p_acl_first(const struct p_packet * packet);

LIBPARTICLE_API struct p_acl_tuple *p_acl_next(const struct p_packet * packet, const struct p_acl_tuple * acl_tuple);

LIBPARTICLE_API int p_acl_findfirst(const struct p_packet * packet, const uint8_t * acl_type, struct p_acl_tuple ** found_tuple);

LIBPARTICLE_API int p_acl_findfirst_str(const struct p_packet * packet, const char * acl_type, struct p_acl_tuple ** found_tuple);

LIBPARTICLE_API int p_acl_findnext(const struct p_packet * packet, struct p_acl_tuple * current_tuple, struct p_acl_tuple ** found_tuple);

LIBPARTICLE_API int p_acl_add_tuple(struct p_packet *pkt, struct p_acl_tuple *acl, int may_frag);

LIBPARTICLE_API int p_acl_add(struct p_packet * pkt, const uint8_t * type, const uint8_t * data, size_t len, int may_frag);

LIBPARTICLE_API int p_acl_add_str(struct p_packet *pkt, const char *type_str, const uint8_t *data, size_t len, int may_frag);

LIBPARTICLE_API struct p_acl_tuple *p_acl_new(const uint8_t *type, const uint8_t *data, size_t len );

LIBPARTICLE_API struct p_acl_tuple *p_acl_new_str(const char *type_str, const uint8_t *data, size_t len);

LIBPARTICLE_API ssize_t p_acl_get_data(const struct p_acl_tuple * acl, uint8_t ** data) ;

LIBPARTICLE_API ssize_t p_acl_get_len(const struct p_acl_tuple *acl);

LIBPARTICLE_API const uint8_t * p_acl_get_type(const struct p_acl_tuple * acl) ;

LIBPARTICLE_API char * p_acl_get_type_str(const struct p_acl_tuple *acl, char *buf);

LIBPARTICLE_API struct p_acl_tuple* p_acl_dup(const struct p_acl_tuple* acl);

LIBPARTICLE_API uint8_t p_acl_cmp(const struct p_acl_tuple *first, const struct p_acl_tuple *second);

#endif /* _PACKET_H_ */

---