.\" 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.output.tlscli 3 "1.3.0" "dnsjit"
.SH NAME
dnsjit.output.tlscli \- Simple TLS client
.SH SYNOPSIS
  local output = require("dnsjit.output.tlscli").new("127.0.0.1", "853")
.SH DESCRIPTION
Simple TLS client that attempts to do a TLS handshake (without
certificate verification). It behaves the same way as tcpcli, except all
the data is sent over the encrypted channel.
.SS Attributes
.TP
timeout
A
.I core.timespec
that is used when producing objects.
.SS Functions
.TP
.BR Tlscli.new "()"
Create a new Tlscli output.
.TP
.BR Tlscli:timeout "(seconds, nanoseconds)"
Set the timeout when producing objects.
.TP
.BR Tlscli:connect "(host, port)"
Connect to the
.I host
and
.I port
, perform a TLS handshake and return 0 if successful.
.TP
.BR Tlscli:receive "()"
Return the C functions and context for receiving objects, these objects
will be sent.
.TP
.BR Tlscli:produce "()"
Return the C functions and context for producing objects, these objects
are received.
The producer will wait for data and if timed out (see
.IR timeout )
it will return a payload object with length zero.
If a timeout happens during during the first stage, getting the length, it
will fail and return nil.
Additional calls will continue retrieving the payload.
The producer returns nil on error.
.TP
.BR Tlscli:packets "()"
Return the number of "packets" sent, actually the number of completely sent
payloads.
.TP
.BR Tlscli:received "()"
Return the number of "packets" received, actually the number of completely
received DNS messages.
.TP
.BR Tlscli:errors "()"
Return the number of errors when sending.
.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