summaryrefslogtreecommitdiff
path: root/src/tcp/tcp_timeout.cc
blob: f11902f10aad46b9a9adf19c50b63b1454644f66 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
// Copyright (C) 2017,2019   John Donoghue   <john.donoghue@ieee.org>
// Copyright (C) 2013   Stefan Mahr     <dac922@gmx.de>
// Copyright (C) 2012   Andrius Sutas   <andrius.sutas@gmail.com>
//
// This program 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.
//
// This program 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 this program; if not, see <http://www.gnu.org/licenses/>.

#include <octave/oct.h>

#ifdef HAVE_CONFIG_H
#include "../config.h"
#endif

#ifdef BUILD_TCP
#include "tcp_class.h"
#endif

// PKG_ADD: autoload ("tcp_timeout", "tcp.oct");
DEFUN_DLD (tcp_timeout, args, nargout,
        "-*- texinfo -*-\n\
@deftypefn {Loadable Function} {} tcp_timeout (@var{tcp}, @var{timeout})\n \
@deftypefnx {Loadable Function} {@var{t} = } tcp_timeout (@var{tcp})\n \
\n\
Set new or get existing tcp interface timeout parameter used for tcp_read() requests. The timeout value is specified in milliseconds.\n \
\n\
@subsubheading Inputs\n \
@var{tcp} - instance of @var{octave_tcp} class.@* \
@var{timeout} - tcp_read() timeout value in milliseconds. Value of -1 means a blocking call.\n \
\n\
@subsubheading Outputs\n \
If @var{timeout} parameter is omitted, the tcp_timeout() shall return current timeout value as the result @var{t}.\n \
@end deftypefn")
{
#ifndef BUILD_TCP
  error("tcp: Your system doesn't support the TCP interface");
  return octave_value ();
#else
  if (args.length () < 1 || args.length () > 2 || args (0).type_id () != octave_tcp::static_type_id ())
    {
      print_usage ();
      return octave_value (-1);
    }

  octave_tcp* tcp = NULL;

  const octave_base_value& rep = args (0).get_rep ();
  tcp = &((octave_tcp &)rep);

  // Setting new timeout
  if (args.length () > 1)
    {
      if ( !(args (1).OV_ISINTEGER () || args (1).OV_ISFLOAT ()) )
        {
          print_usage ();
          return octave_value (-1);
        }
      if (args (1).double_value() >= 0.0)
        tcp->set_timeout (args (1).double_value ()/1000.0);
      else
        tcp->set_timeout (-1);

      return octave_value (); // Should it return by default?
    }

  // Returning current timeout
  double timeout = tcp->get_timeout ();
  if (timeout < 0)
    return octave_value (-1);
  else
    return octave_value (timeout*1000.0);
#endif
}

#if 0
%!xtest
%! addr = resolvehost ('gnu.org', 'address');
%! a = tcp (addr, 80);
%! assert(tcp_timeout(a), -1);
%! a.timeout = 2.5;
%! assert(tcp_timeout(a), 2500);
%! a.timeout = 0;
%! assert(tcp_timeout(a), 0);
%! a.timeout = -1;
%! assert(tcp_timeout(a), -1);
%! tcp_close(a);
#endif