i_serial_driver_service.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (c) 2012 Coronis
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser 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
 * Lesser General Public License for more details.

 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Contributors:
 *     Coronis - initial API and implementation
 *******************************************************************************/

#ifndef _I_SERIAL_DRIVER_SERVICE_H_
#define _I_SERIAL_DRIVER_SERVICE_H_

#include <i_serial_frame.h>
#include <i_serial_driver_listener_types.h>

#ifdef  _WINDOWS
#define WAVENIS_API __declspec(dllexport)
#else
#define WAVENIS_API extern
#endif//_WINDOWS

WAVENIS_API void* driver_create();

WAVENIS_API int driver_destroy( const void* driver );

WAVENIS_API int driver_init( const void* driver );

WAVENIS_API int driver_init_from_file( const void* driver, const char* file );

WAVENIS_API int driver_open( const void* driver );

WAVENIS_API int driver_close( const void* driver );

WAVENIS_API int driver_is_open( const void* driver );

WAVENIS_API int driver_get_port_id( const void* driver, char* id, int idLen );

WAVENIS_API int driver_set_port_id( const void* driver, const char* id );

WAVENIS_API int driver_set_port_params( const void* driver, int baudRate, int dataBit, int stopBit, int parity );

WAVENIS_API int driver_set_listening_period_param( const void* driver, int receiveTimeout );

WAVENIS_API int driver_set_flow_control_mode_params( const void* driver, int flowControlIn, int flowControlOut );

WAVENIS_API int driver_send( const void* driver, const pISerialFrame frame);

WAVENIS_API int driver_register_listener( const void* driver, serial_driver_listener_t receiveFrameListener, void* param );

WAVENIS_API int driver_unregister_listener( const void* driver );

WAVENIS_API int driver_register_notify_listener( const void* driver, serial_driver_listener_notify_t eventListener, void* param );

WAVENIS_API int driver_unregister_notify_listener( const void* driver );

WAVENIS_API int driver_register_spy_listener( const void* driver, serial_driver_spy_t spySentFrameListener, serial_driver_spy_t spyRecvFrameListener, void* param, int* spyIndex );

WAVENIS_API int driver_unregister_spy_listener( const void* driver, int spyIndex );

#endif//_I_SERIAL_DRIVER_SERVICE_H_