.\" 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.output.respdiff 3 "1.2.3" "dnsjit"
.SH NAME
dnsjit.output.respdiff \- Output to respdiff LMDB
.SH SYNOPSIS
  local output = require("dnsjit.output.respdiff").new("/path/to/lmdb")
.SH DESCRIPTION
Output to an LMDB database (format 2018-05-21) that can be used by respdiff
to compare the responses found in the input data with the responses
received.
The receive function expects to get a chain of 2 or 3
.IR core.object.payload .
For a completed query; The top of the chain is the query, after it the
original response and then the received response.
For a timed out query; The top of the chain is the query, after it the
original response.
.SS Functions
.TP
.BR Respdiff.new "(path, origname, recvname, mapsize)"
Create a new Respdiff output and created the LMDB database in the directory
.IR path .
The
.I origname
and
.I recvname
are used to populate the meta table, these names should be the same as
what is configured in
.IR respdiff.cfg .
Optional
.I mapsize
can be given to increase the database size beyond the default size of 10MB.
.TP
.BR Respdiff:log "()"
Return the Log object to control logging of this instance or module.
.TP
.BR Respdiff:receive "()"
Return the C functions and context for receiving objects.
.TP
.BR Respdiff:commit "(start_time, end_time)"
Commit the LMDB transactions, can not store any more objects after this
call.
The given
.I start_time
and
.I end_time
are used to fill the meta table.
.SH SEE ALSO
.BR respdiff " https://gitlab.nic.cz/knot/respdiff"
.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