xref: /freebsd/contrib/libpcap/pcap_setnonblock.3pcap (revision 87b759f0fa1f7554d50ce640c40138512bbded44)
Copyright (c) 1994, 1996, 1997
The Regents of the University of California. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that: (1) source code distributions
retain the above copyright notice and this paragraph in its entirety, (2)
distributions including binary code include the above copyright notice and
this paragraph in its entirety in the documentation or other materials
provided with the distribution, and (3) all advertising materials mentioning
features or use of this software display the following acknowledgement:
``This product includes software developed by the University of California,
Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
the University 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 ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

PCAP_SETNONBLOCK 3PCAP "30 November 2023"
NAME
pcap_setnonblock, pcap_getnonblock - set or get the state of non-blocking mode on a capture device
SYNOPSIS
#include <pcap/pcap.h>

char errbuf[PCAP_ERRBUF_SIZE];

int pcap_setnonblock(pcap_t *p, int nonblock, char *errbuf); int pcap_getnonblock(pcap_t *p, char *errbuf);

DESCRIPTION
pcap_setnonblock () puts a capture handle into ``non-blocking'' mode, or takes it out of ``non-blocking'' mode, depending on whether the nonblock argument is non-zero or zero. It has no effect on ``savefiles''. errbuf is a buffer large enough to hold at least PCAP_ERRBUF_SIZE chars.

In ``non-blocking'' mode, an attempt to read from the capture descriptor with pcap_dispatch (3PCAP) and pcap_next_ex (3PCAP) will, if no packets are currently available to be read, return 0 immediately rather than blocking waiting for packets to arrive.

pcap_loop (3PCAP) will loop forever, consuming CPU time when no packets are currently available; pcap_dispatch () should be used instead. pcap_next (3PCAP) will return NULL if there are no packets currently available to read; this is indistinguishable from an error, so pcap_next_ex () should be used instead.

When first activated with pcap_activate (3PCAP) or opened with pcap_open_live (3PCAP), a capture handle is not in ``non-blocking mode''; a call to pcap_setnonblock () is required in order to put it into ``non-blocking'' mode.

RETURN VALUE
pcap_setnonblock() return 0 on success, PCAP_ERROR_NOT_ACTIVATED if called on a capture handle that has been created but not activated, and PCAP_ERROR for other errors. pcap_getnonblock () returns the current ``non-blocking'' state of the capture descriptor on success; it always returns 0 on ``savefiles''. It returns PCAP_ERROR_NOT_ACTIVATED if called on a capture handle that has been created but not activated, and PCAP_ERROR for other errors. If PCAP_ERROR is returned, errbuf is filled in with an appropriate error message.
SEE ALSO
pcap (3PCAP), pcap_next_ex (3PCAP), pcap_geterr (3PCAP)