Skip to content

Commit e93f79c

Browse files
committed
Deprecate this repo.
1 parent 5193978 commit e93f79c

File tree

115 files changed

+3
-55196
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

115 files changed

+3
-55196
lines changed

LICENSE.txt

Lines changed: 0 additions & 202 deletions
This file was deleted.

README.md

Lines changed: 3 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,4 @@
1-
![](https://github.com/SiliconLabs/java_pcap_file_utilities/workflows/Jar%20Build/badge.svg)
1+
# Deprecation notice
22

3-
# What is this?
4-
5-
Java-pcap is a java implementation of PCAP and PCAPNG file format.
6-
This library provides classes and methods required to read both PCAP and
7-
PCAPNG file format and write out the PCAPNG file format.
8-
9-
# How do I build this library?
10-
11-
You can build it using gradle via:
12-
```
13-
./gradlew jar
14-
```
15-
This will result in a file:
16-
17-
`pcap/build/libs/java-pcap-<VERSION>.jar`
18-
19-
# How do I use this library?
20-
21-
A quick and dirty way is to simply use the jar from command line:
22-
```
23-
java -jar pcap/build/libs/java-pcap-<VERSION>.jar dump <PCAP_FILE>
24-
```
25-
This will read the pcap or pcapng file provided and print out the details from that file.
26-
27-
Full command line options are printed if you provide no arguments:
28-
```
29-
java -jar pcap/build/libs/java-pcap-<VERSION>.jar
30-
```
31-
32-
33-
# Can I contribute to this library?
34-
35-
Yes, please do. Follow the normal github guidelines around pull requests and we will consider your submission and merge the code back into the library when approved.
36-
37-
# What are the APIs for reading a PCAP or PCAPNG file?
38-
39-
The simplest example of a loop that reads entire block inside the pcap or
40-
pcapng file is as follows:
41-
```
42-
File f = ...;
43-
try (IPcapInput in = Pcap.openForReading(f)) {
44-
Block b;
45-
while ( (b=in.nextBlock()) != null ) {
46-
... // do something with a block
47-
}
48-
}
49-
```
50-
51-
For a more detailed example, see the simple file creation and reading
52-
in a unit test under:
53-
54-
`src/test/java/com/silabs.pcap/PcapTest.java`
55-
56-
# Documentation
57-
58-
* [Javadoc](https://siliconlabs.github.io/java_pcap_file_utilities/javadoc/index.html)
59-
60-
# References
61-
62-
* [Description of the PCAP format](https://wiki.wireshark.org/Development/LibpcapFileFormat)
63-
* [Description of the PCAPNG format](https://github.com/pcapng/pcapng/)
64-
65-
66-
# License
67-
68-
This library was originally developed by Silicon Labs.
69-
It is now provided as open source, licensed by [Apache 2.0 license](LICENSE.txt).
3+
This repo has been discontinued.
4+
The project has been moved to [this repo.](https://github.com/SiliconLabsSoftware/java-pcap)

docs/_config.yml

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)