https://github.com/drbrain/capp

A ruby libpcap wrapper that is GVL-friendly
https://github.com/drbrain/capp

Last synced: about 1 year ago
JSON representation

A ruby libpcap wrapper that is GVL-friendly

• Host: GitHub
• URL: https://github.com/drbrain/capp
• Owner: drbrain
• Created: 2013-03-24T22:15:12.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2015-01-08T23:58:36.000Z (over 11 years ago)
• Last Synced: 2025-05-11T22:46:01.174Z (about 1 year ago)
• Language: C
• Size: 512 KB
• Stars: 10
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rdoc
  • Changelog: History.rdoc

Awesome Lists containing this project

README

          
= capp

home :: https://github.com/drbrain/capp

rdoc :: http://docs.seattlerb.org/capp

bugs :: https://github.com/drbrain/capp/issues

== Description

Capp is a packet capture library that wraps libpcap.  Capp provides a simple

API for capturing packets and automatically unpacks common packets (including

Ethernet, IP, TCP, UDP and ICMP).  Capp also cooperates with other threads

better than other pcap wrapper libraries for ruby.

This product includes software developed by the University of California,

Lawrence Berkeley Laboratory and its contributors.

== Examples

Basic single-thread packet capturing:

  require 'capp'

  Capp.live.loop do |packet|

    # ...

  end

Basic multi-thread packet capturing:

  require 'capp'

  require 'thread'

  q = Queue.new

  Thread.new do

    while packet = q.deq do

      # ...

    end

  end

  capp = Capp.live.loop do |packet|

    q.enq packet

  end

== Requirements

* libpcap, tested with 1.1.1 and 1.3.0

== Install

  sudo gem install capp

== Developers

After checking out the source, run:

  $ rake newb

  $ rake newb

This task will install any missing dependencies, run the tests/specs,

and generate the RDoc.  You need to run it twice as the first run installs the

dependencies needed to compile the C extension.

== License

Portions copyright The Regents of the University of California.  See

individual files for details.

(The MIT License)

Copyright (c) Eric Hodel

Permission is hereby granted, free of charge, to any person obtaining

a copy of this software and associated documentation files (the

'Software'), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to

permit persons to whom the Software is furnished to do so, subject to

the following conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.