Merge branch 'vendor/LIBPCAP'
[dragonfly.git] / contrib / libpcap / pcap_inject.3pcap
1 .\" @(#) $Header: /tcpdump/master/libpcap/pcap_inject.3pcap,v 1.3 2008-04-06 02:53:22 guy Exp $
2 .\"
3 .\" Copyright (c) 1994, 1996, 1997
4 .\"     The Regents of the University of California.  All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that: (1) source code distributions
8 .\" retain the above copyright notice and this paragraph in its entirety, (2)
9 .\" distributions including binary code include the above copyright notice and
10 .\" this paragraph in its entirety in the documentation or other materials
11 .\" provided with the distribution, and (3) all advertising materials mentioning
12 .\" features or use of this software display the following acknowledgement:
13 .\" ``This product includes software developed by the University of California,
14 .\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
15 .\" the University nor the names of its contributors may be used to endorse
16 .\" or promote products derived from this software without specific prior
17 .\" written permission.
18 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
19 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
20 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
21 .\"
22 .TH PCAP_INJECT 3PCAP "5 April 2008"
23 .SH NAME
24 pcap_inject, pcap_sendpacket \- transmit a packet
25 .SH SYNOPSIS
26 .nf
27 .ft B
28 #include <pcap/pcap.h>
29 .ft
30 .LP
31 .ft B
32 int pcap_inject(pcap_t *p, const void *buf, size_t size);
33 int pcap_sendpacket(pcap_t *p, const u_char *buf, int size);
34 .ft
35 .fi
36 .SH DESCRIPTION
37 .B pcap_inject()
38 sends a raw packet through the network interface;
39 .I buf
40 points to the data of the packet, including the link-layer header, and
41 .I size
42 is the number of bytes in the packet.
43 .PP
44 Note that, even if you successfully open the network interface, you
45 might not have permission to send packets on it, or it might not support
46 sending packets; as
47 .I pcap_open_live()
48 doesn't have a flag to indicate whether to open for capturing, sending,
49 or capturing and sending, you cannot request an open that supports
50 sending and be notified at open time whether sending will be possible.
51 Note also that some devices might not support sending packets.
52 .PP
53 Note that, on some platforms, the link-layer header of the packet that's
54 sent might not be the same as the link-layer header of the packet
55 supplied to
56 .BR pcap_inject() ,
57 as the source link-layer address, if the header contains such an
58 address, might be changed to be the address assigned to the interface on
59 which the packet it sent, if the platform doesn't support sending
60 completely raw and unchanged packets.  Even worse, some drivers on some
61 platforms might change the link-layer type field to whatever value
62 libpcap used when attaching to the device, even on platforms that
63 .I do
64 nominally support sending completely raw and unchanged packets.
65 .PP
66 .B pcap_sendpacket()
67 is like
68 .BR pcap_inject() ,
69 but it returns 0 on success, rather than returning the number of bytes
70 written.
71 .RB ( pcap_inject()
72 comes from OpenBSD;
73 .B pcap_sendpacket()
74 comes from WinPcap.  Both are provided for compatibility.)
75 .SH RETURN VALUE
76 .B pcap_inject()
77 returns the number of bytes written on success and \-1 on failure.
78 .PP
79 .B pcap_sendpacket()
80 returns 0 on success and \-1 on failure.
81 .PP
82 If \-1 is returned,
83 .B pcap_geterr()
84 or
85 .B pcap_perror()
86 may be called with
87 .I p
88 as an argument to fetch or display the error text.
89 .SH SEE ALSO
90 pcap(3PCAP), pcap_geterr(3PCAP)