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