io.pkts

Class Pcap

java.lang.Object

io.pkts.Pcap

public class Pcap
extends java.lang.Object

Author:

jonas@jonasborjesson.com

Method Summary

Modifier and Type	Method and Description
void	close()
PcapOutputStream	createOutputStream(java.io.OutputStream out) Create an PcapOutputStream based on this Pcap.
void	loop(PacketHandler callback)
static Pcap	openStream(java.io.File file)
static Pcap	openStream(java.io.InputStream is) Capture packets from the input stream
static Pcap	openStream(java.io.InputStream is, int bufferCapacity) Capture packets from the input stream
static Pcap	openStream(java.lang.String file)
void	setFilter(java.lang.String expression) It is possible to specify a filter so that only packets that matches the filter will be passed onto the registered PacketHandler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setFilter

public void setFilter(java.lang.String expression)
               throws FilterParseException

It is possible to specify a filter so that only packets that matches the filter will be passed onto the registered PacketHandler. E.g., to only accept packets of type sip with the Call-ID of "123" you could pass in the following filter: "sip.Call-ID == 123"

Parameters:

expression - the expression. If the expression is null or the empty string, it will silently be ignored.

Throws:

FilterParseException - in case the expression is not a valid filter expression.

loop

public void loop(PacketHandler callback)
          throws java.io.IOException,
                 FramingException

Throws:

java.io.IOException

FramingException

createOutputStream

public PcapOutputStream createOutputStream(java.io.OutputStream out)
                                    throws java.lang.IllegalArgumentException

Create an PcapOutputStream based on this Pcap. The new PcapOutputStream is configured to use the same PcapGlobalHeader as the Pcap is using which means that you can just safely write frames back out to this PcapOutputStream. Good for those applications that needs to filter a Pcap and write out new files.

Parameters:

out -

Returns:

Throws:

java.lang.IllegalArgumentException

openStream

public static Pcap openStream(java.io.InputStream is)
                       throws java.io.IOException

Capture packets from the input stream

Parameters:

is -

Returns:

Throws:

java.io.IOException

openStream

public static Pcap openStream(java.io.InputStream is,
                              int bufferCapacity)
                       throws java.io.IOException

Capture packets from the input stream

Parameters:

is -

bufferCapacity - Size of buffer, must be larger than PCAPs largest framesize. See SNAPLENGTH for tcpdump, et.al.

Returns:

Throws:

java.io.IOException

openStream

public static Pcap openStream(java.io.File file)
                       throws java.io.FileNotFoundException,
                              java.io.IOException

Parameters:

file - the pcap file

Returns:

a new Pcap

Throws:

java.io.FileNotFoundException - in case the file doesn't exist.

java.io.IOException

openStream

public static Pcap openStream(java.lang.String file)
                       throws java.io.FileNotFoundException,
                              java.io.IOException

Parameters:

file -

Returns:

Throws:

java.io.FileNotFoundException

java.io.IOException

close

public void close()