.\" Copyright (c) 2018-2022, 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.gre 3 "1.2.3" "dnsjit"
.SH NAME
dnsjit.core.object.gre \- Generic Routing Encapsulation (GRE) part of a packet
.SH DESCRIPTION
The GRE part of a packet that usually can be found in the object chain
after parsing with, for example, Layer filter.
See RFC 1701.
.SS Attributes
.TP
gre_flags
The GRE flags.
.TP
ether_type
The protocol type of the payload packet.
.TP
checksum
The checksum of the GRE header and the payload packet.
.TP
key
The Key field contains a four octet number which was inserted by
the encapsulator.
.TP
sequence
The Sequence Number field contains an unsigned 32 bit integer which is
inserted by the encapsulator.
.SS Functions
.TP
.BR Gre:type "()"
Return the textual type of the object.
.TP
.BR Gre:prev "()"
Return the previous object.
.TP
.BR Gre:cast "()"
Cast the object to the underlining object module and return it.
.TP
.BR Gre:uncast "()"
Cast the object to the generic object module and return it.
.TP
.BR Gre:copy "()"
Make a copy of the object and return it.
.TP
.BR Gre:free "()"
Free the object, should only be used on copies or otherwise allocated.
.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