Common device API file. More...

This graph shows which files directly or indirectly include this file:

Classes
struct	CONN_PARAM_COM
	A type definition for serial connection parameters. More...
struct	CONN_PARAM_COMMON
	A type definition for common communication parameters. More...
struct	CONN_PARAM_ETH
	A type definition for Ethernet connection parameters. More...
Defines
#define	_DN_EXP_DEVICE
#define	DEV_BUF_MAX ((uint16_t)-1)
	The maximum buffer size of a packet.
#define	E_INVALIDPACKET _HRESULT_TYPEDEF_(0x80010000L)
	Failed because the packet is invalid.
#define	EVENPARITY (2)
	A definition for serial communication setting.
#define	NOPARITY (0)
	A definition for serial communication setting.
#define	ODDPARITY (1)
	A definition for serial communication setting.
#define	ONESTOPBIT (0)
	A definition for serial communication setting.
#define	TWOSTOPBITS (2)
	A definition for serial communication setting.
Enumerations
enum	CONN_PARAM_CHECK_FLAG { CHECK_TYPE_TCP = 0x0001, CHECK_TYPE_UDP = 0x0002, CHECK_TYPE_COM = 0x0004, CHECK_TYPE_ALL = 0x00FF, CHECK_FUNC_OPEN = 0x0100, CHECK_FUNC_CLOSE = 0x0200, CHECK_FUNC_SEND = 0x0400, CHECK_FUNC_RECV = 0x0800, CHECK_FUNC_TIMEOUT = 0x1000, CHECK_FUNC_CLEAR = 0x2000, CHECK_FUNC_ALL = 0xFF00 }
	Definitions for check_conn_param function. More...
enum	CONN_TYPE { CONN_TCP = CHECK_TYPE_TCP, CONN_UDP = CHECK_TYPE_UDP, CONN_COM = CHECK_TYPE_COM }
	Connection type. More...
Functions
_DN_EXP_DEVICE HRESULT	check_conn_param (const struct CONN_PARAM_COMMON *device, int flag)
	Checks the communication parameters.
_DN_EXP_DEVICE HRESULT	check_timeout (int sock, uint32_t timeout)
	Checks the communication timeout.
_DN_EXP_DEVICE void	memcpy_be (void dst, const void src, uint32_t len)
	Orders to big endian.
_DN_EXP_DEVICE void	memcpy_le (void dst, const void src, uint32_t len)
	Orders to little endian.
_DN_EXP_DEVICE HRESULT	parse_conn_param_ether (const char opt, struct CONN_PARAM_ETH param)
	Parses Ethernet connection parameters.
_DN_EXP_DEVICE HRESULT	parse_conn_param_serial (const char opt, struct CONN_PARAM_COM param)
	Parses serial connection parameters.
_DN_EXP_DEVICE int	parse_conn_type (const char *opt)
	Parses and returns the connection type.

Detailed Description

Common device API file.

Defines common device APIs.

Version:: 1.0

Date:: 2014/11/06

Author:: DENSO WAVE

Software License Agreement (MIT License)

Copyright:: Copyright (c) 2015 DENSO WAVE INCORPORATED

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Definition in file dn_device.h.

Define Documentation

#define _DN_EXP_DEVICE

Definition at line 37 of file dn_device.h.

#define DEV_BUF_MAX ((uint16_t)-1)

The maximum buffer size of a packet.

Definition at line 101 of file dn_device.h.

#define E_INVALIDPACKET _HRESULT_TYPEDEF_(0x80010000L)

Failed because the packet is invalid.

Definition at line 107 of file dn_device.h.

#define EVENPARITY (2)