Mercurial > forge
view main/instrument-control/src/tcp/tcp_timeout.cc @ 11580:7f7e874d2572 octave-forge
instrument:control: fix gpib timeout documentation
author | dac922 |
---|---|
date | Sun, 31 Mar 2013 12:07:47 +0000 |
parents | f6940608a0fe |
children | 0b64fe2f4753 |
line wrap: on
line source
// 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" static bool type_loaded = false; #endif 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\ @var{tcp} - instance of @var{octave_tcp} class.\n \ @var{timeout} - tcp_read() timeout value in milliseconds. Value of -1 means a blocking call.\n \ \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 (!type_loaded) { octave_tcp::register_type(); type_loaded = true; } 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).is_integer_type() || args(1).is_float_type()) ) { print_usage(); return octave_value(-1); } tcp->set_timeout(args(1).int_value()); return octave_value(); // Should it return by default? } // Returning current timeout return octave_value(tcp->get_timeout()); #endif }