gPTP Documentation
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
packet.hpp
Go to the documentation of this file.
1 /******************************************************************************
2 
3  Copyright (c) 2009-2012, Intel Corporation
4  All rights reserved.
5 
6  Redistribution and use in source and binary forms, with or without
7  modification, are permitted provided that the following conditions are met:
8 
9  1. Redistributions of source code must retain the above copyright notice,
10  this list of conditions and the following disclaimer.
11 
12  2. Redistributions in binary form must reproduce the above copyright
13  notice, this list of conditions and the following disclaimer in the
14  documentation and/or other materials provided with the distribution.
15 
16  3. Neither the name of the Intel Corporation nor the names of its
17  contributors may be used to endorse or promote products derived from
18  this software without specific prior written permission.
19 
20  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  POSSIBILITY OF SUCH DAMAGE.
31 
32 ******************************************************************************/
33 
34 
35 #ifndef PACKET_H
36 #define PACKET_H
37 
38 #include "stdint.h"
39 
42 #define ETHER_ADDR_OCTETS 6
43 #define PACKET_HDR_LENGTH 14
60 typedef enum {
61  PACKET_NO_ERROR = 0, PACKET_NOMEMORY_ERROR, PACKET_BADBUFFER_ERROR, PACKET_XMIT_ERROR, PACKET_IFLOOKUP_ERROR, PACKET_IFNOTFOUND_ERROR,
62  PACKET_CREATEMUTEX_ERROR, PACKET_GETMUTEX_ERROR, PACKET_RLSMUTEX_ERROR, PACKET_RECVTIMEOUT_ERROR, PACKET_RECVFAILED_ERROR,
63  PACKET_BIND_ERROR
65 
69 typedef struct {
70  uint8_t addr[ETHER_ADDR_OCTETS];
75 typedef struct packet_handle * pfhandle_t;
76 
88 void freePacketHandle( pfhandle_t pfhandle );
89 
97 packet_error_t openInterfaceByAddr( pfhandle_t pfhandle, packet_addr_t *addr, int timeout );
103 void closeInterface( pfhandle_t pfhandle );
113 packet_error_t sendFrame( pfhandle_t pfhandle, packet_addr_t *addr, uint16_t ethertype, uint8_t *payload, size_t length );
122 packet_error_t recvFrame( pfhandle_t pfhandle, packet_addr_t *addr, uint8_t *payload, size_t &length );
123 
130 packet_error_t packetBind( struct packet_handle *handle, uint16_t ethertype );
131 
132 #endif /* PACKET_H */
packet_error_t
Definition: packet.hpp:60
struct packet_handle * pfhandle_t
Definition: packet.hpp:75
packet_error_t openInterfaceByAddr(pfhandle_t pfhandle, packet_addr_t *addr, int timeout)
Opens the interface by link layer address. Uses libpcap.
void freePacketHandle(pfhandle_t pfhandle)
Close the packet handle.
packet_error_t recvFrame(pfhandle_t pfhandle, packet_addr_t *addr, uint8_t *payload, size_t &length)
Receives a frame.
packet_error_t packetBind(struct packet_handle *handle, uint16_t ethertype)
Set filters for packet handler.
packet_error_t sendFrame(pfhandle_t pfhandle, packet_addr_t *addr, uint16_t ethertype, uint8_t *payload, size_t length)
Sends a frame through an interface using libpcap.
void closeInterface(pfhandle_t pfhandle)
Close the interface.
packet_error_t mallocPacketHandle(pfhandle_t *pfhandle_r)
Allocate memory for the packet handle.
#define ETHER_ADDR_OCTETS
Definition: packet.hpp:42
Definition: packet.hpp:69