pcap_breakloop.3pcap

   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_BREAKLOOP 3PCAP "25 July 2018"
  21 .SH NAME
  22 pcap_breakloop \- force a pcap_dispatch() or pcap_loop() call to return
  23 .SH SYNOPSIS
  24 .nf
  25 .ft B
  26 #include <pcap/pcap.h>
  27 .ft
  28 .LP
  29 .ft B
  30 void pcap_breakloop(pcap_t *);
  31 .ft
  32 .fi
  33 .SH DESCRIPTION
  34 .B pcap_breakloop()
  35 sets a flag that will force
  36 .B pcap_dispatch(3PCAP)
  37 or
  38 .B pcap_loop(3PCAP)
  39 to return rather than looping; they will return the number of packets
  40 that have been processed so far, or
  41 .B PCAP_ERROR_BREAK
  42 if no packets have been processed so far.
  43 .PP
  44 This routine is safe to use inside a signal handler on UNIX or a console
  45 control handler on Windows, as it merely sets a flag that is checked
  46 within the loop.
  47 .PP
  48 The flag is checked in loops reading packets from the OS - a signal by
  49 itself will not necessarily terminate those loops - as well as in loops
  50 processing a set of packets returned by the OS.
  51 .ft B
  52 Note that if you are catching signals on UNIX systems that support
  53 restarting system calls after a signal, and calling pcap_breakloop()
  54 in the signal handler, you must specify, when catching those signals,
  55 that system calls should NOT be restarted by that signal.  Otherwise,
  56 if the signal interrupted a call reading packets in a live capture,
  57 when your signal handler returns after calling pcap_breakloop(), the
  58 call will be restarted, and the loop will not terminate until more
  59 packets arrive and the call completes.
  60 .ft R
  61 .PP
  62 .ft B
  63 Note also that, in a multi-threaded application, if one thread is
  64 blocked in pcap_dispatch(), pcap_loop(), pcap_next(3PCAP), or pcap_next_ex(3PCAP),
  65 a call to pcap_breakloop() in a different thread will not unblock that
  66 thread.
  67 .ft R
  68 You will need to use whatever mechanism the OS provides for
  69 breaking a thread out of blocking calls in order to unblock the thread,
  70 such as thread cancellation or thread signalling in systems that support
  71 POSIX threads, or
  72 .B SetEvent()
  73 on the result of
  74 .B pcap_getevent()
  75 on a
  76 .B pcap_t
  77 on which the thread is blocked on Windows.  Asynchronous procedure calls
  78 will not work on Windows, as a thread blocked on a
  79 .B pcap_t
  80 will not be in an alertable state.
  81 .ft R
  82 .PP
  83 Note that
  84 .B pcap_next()
  85 and
  86 .B pcap_next_ex()
  87 will, on some platforms, loop reading packets from the OS; that loop
  88 will not necessarily be terminated by a signal, so
  89 .B pcap_breakloop()
  90 should be used to terminate packet processing even if
  91 .B pcap_next()
  92 or
  93 .B pcap_next_ex()
  94 is being used.
  95 .PP
  96 .B pcap_breakloop()
  97 does not guarantee that no further packets will be processed by
  98 .B pcap_dispatch()
  99 or
 100 .B pcap_loop()
 101 after it is called; at most one more packet might be processed.
 102 .PP
 103 If
 104 .B PCAP_ERROR_BREAK
 105 is returned from
 106 .B pcap_dispatch()
 107 or
 108 .BR pcap_loop() ,
 109 the flag is cleared, so a subsequent call will resume reading packets.
 110 If a positive number is returned, the flag is not cleared, so a
 111 subsequent call will return
 112 .B PCAP_ERROR_BREAK
 113 and clear the flag.
 114 .SH SEE ALSO
 115 pcap(3PCAP)