.\" Copyright (c) 2018-2023, OARC, Inc.
.\" All rights reserved.
.\"
.\" This file is part of dnsjit.
.\"
.\" dnsjit is free software: you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation, either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" dnsjit is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with dnsjit.  If not, see <http://www.gnu.org/licenses/>.
.\"
.TH dnsjit.core.object.ip 3 "1.3.0" "dnsjit"
.SH NAME
dnsjit.core.object.ip \- An IP packet
.SH DESCRIPTION
An IP packet that usually can be found in the object chain
after parsing with, for example, Layer filter.
.SS Attributes
.TP
v
Version.
.TP
hl
Header length.
.TP
tos
Type of service.
.TP
len
Total length.
.TP
id
Identification.
.TP
off
Fragment offset field.
.TP
ttl
Time to live.
.TP
p
Protocol.
.TP
sum
Checksum.
.TP
src
Source address.
.TP
dst
Destination address.
.TP
payload
A pointer to the payload.
.TP
plen
The length of the payload.
.TP
pad_len
The length of padding found, if any.
.SS Functions
.TP
.BR Ip:type "()"
Return the textual type of the object.
.TP
.BR Ip:prev "()"
Return the previous object.
.TP
.BR Ip:cast "()"
Cast the object to the underlining object module and return it.
.TP
.BR Ip:uncast "()"
Cast the object to the generic object module and return it.
.TP
.BR Ip:copy "()"
Make a copy of the object and return it.
.TP
.BR Ip:free "()"
Free the object, should only be used on copies or otherwise allocated.
.TP
.BR Ip:source "()"
Return the IP source as a string.
.TP
.BR Ip:destination "()"
Return the IP destination as a string.
.SH SEE ALSO
.BR dnsjit.core.object (3),
.BR dnsjit.filter.layer (3)
.SH AUTHORS and CONTRIBUTORS
Jerry Lundström (DNS-OARC),
Tomáš Křížek (CZ.NIC),
Petr Špaček (ISC)
.LP
Maintained by DNS-OARC
.LP
.RS
.I https://www.dns-oarc.net/
.RE
.LP
.SH BUGS
For issues and feature requests please use:
.LP
.RS
\fIhttps://github.com/DNS-OARC/dnsjit/issues\fP
.RE
.LP
For question and help please use:
.LP
.RS
\fIadmin@dns-oarc.net\fP
.RE
.LP