view main/instrument-control/src/tcp/tcp_read.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 <octave/uint8NDArray.h>
#include <octave/sighandlers.h>

#include <errno.h>

#include "tcp_class.h"

extern bool read_interrupt;
static bool type_loaded = false;

void read_sighandler(int sig)
{
    printf("tcp_read: Interrupting...\n\r");
    read_interrupt = true;
}
#endif

DEFUN_DLD (tcp_read, args, nargout,
        "-*- texinfo -*-\n\
@deftypefn {Loadable Function} {[@var{data}, @var{count}] = } tcp_read (@var{tcp}, @var{n}, @var{timeout})\n \
\n\
Read from tcp interface.\n \
\n\
@var{tcp} - instance of @var{octave_tcp} class.\n \
@var{n} - number of bytes to attempt to read of type Integer\n \
@var{timeout} - timeout in ms if different from default of type Integer\n \
\n\
The tcp_read() shall return number of bytes successfully read in @var{count} as Integer and the bytes themselves in @var{data} as uint8 array.\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() < 2 || args.length() > 3 || args(0).type_id() != octave_tcp::static_type_id())
    {
        print_usage();
        return octave_value(-1);
    }

    unsigned int buffer_len = 0;

    if ( !(args(1).is_integer_type() || args(1).is_float_type()))
    {
        print_usage();
        return octave_value(-1);
    }

    if ( args.length() > 2 )
    {
        if ( !(args(2).is_integer_type() || args(2).is_float_type()))
        {
            print_usage();
            return octave_value(-1);
        }
    }

    buffer_len = args(1).int_value();

    uint8_t *buffer = NULL;
    buffer = new uint8_t[buffer_len + 1];

    if (buffer == NULL)
    {
        error("tcp_read: cannot allocate requested memory: %s\n", strerror(errno));
        return octave_value(-1);
    }

    octave_tcp* tcp = NULL;

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

    int timeout = tcp->get_timeout();
    if (args.length() == 3)
    {
        timeout = args(2).int_value();
    }

    // Register custom interrupt signal handler
    octave_set_signal_handler(SIGINT, read_sighandler);
    read_interrupt = false;

    // Read data
    int bytes_read = tcp->read(buffer, buffer_len, timeout);

    // Restore default signal handling
    // TODO: a better way?
    install_signal_handlers();

    // Convert data to octave type variables
    octave_value_list return_list;
    uint8NDArray data( dim_vector(1, bytes_read) );

    for (int i = 0; i < bytes_read; i++)
        data(i) = buffer[i];

    return_list(0) = data;
    return_list(1) = bytes_read;

    delete[] buffer;

    return return_list;
#endif
}