bcap_server.h File Reference

b-CAP Server API file. More...

#include "../dn_common.h"
#include "../bcap_funcid.h"

Include dependency graph for bcap_server.h:

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

Go to the source code of this file.

Macros
#define	_BCAP_EXP_SERVER
#define	BCAP_CLIENT_MAX   (20)
	A definition for the maximum count of TCP clients. More...
#define	BCAP_COM_MAX   (1)
	A definition for the maximum count of COM servers. More...
#define	BCAP_OBJECT_MAX   (1000)
	A definition for the maximum count of creatable objects in a thread. More...
#define	BCAP_TCP_MAX   (1)
	A definition for the maximum count of TCP servers. More...
#define	BCAP_UDP_MAX   (1)
	A definition for the maximum count of UDP servers. More...
#define	E_BUSY_PROC   OSERR2HRESULT(ERROR_BUSY)
	Failed because executing process is busy. More...
#define	ERROR_BUSY   (170L)
	The requested resource because executing process is busy. More...
#define	INIT_EXEC_TIMEOUT   (180000)
	A definition for the initial executing timeout. More...
#define	INIT_WDT_INTERVAL   (INFINITE)
	A definition for the initial watch dog timer interval. More...
#define	KEEPALIVE_COUNT   (9)
	A definition for the keep alive count option. More...
#define	KEEPALIVE_ENABLE   (1)
	A definition for the keep alive enable option. More...
#define	KEEPALIVE_IDLE   (7200)
	A definition for the keep alive idle option. More...
#define	KEEPALIVE_INTERVAL   (75)
	A definition for the keep alive interval option. More...
#define	MIN_WDT_INTERVAL   (80)
	A definition for the minimum watch dog timer interval. More...
#define	UDP_LIFELIMIT   (10000)
	A definition for the life limit of a UDP connection. More...

Typedefs
typedef HRESULT(*	CALL_FUNC_BCAP) (VARIANT *vntArgs, int16_t Argc, VARIANT *vntRet)

Functions
_BCAP_EXP_SERVER HRESULT	bCap_Close_Server (int *pfd)
	Ends b-CAP server. More...
_BCAP_EXP_SERVER HRESULT	bCap_Open_Server (const char *connect, uint32_t timeout, int *pfd)
	Starts b-CAP server. More...
_BCAP_EXP_SERVER HRESULT	bCap_SetCallFunc (int32_t id, CALL_FUNC_BCAP func)
	Sets a callback function. More...

Detailed Description

b-CAP Server API file.

Defines b-CAP Server APIs.

Version

1.0

Date

2015/1/10

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 bcap_server.h.

Macro Definition Documentation

#define _BCAP_EXP_SERVER

Definition at line 37 of file bcap_server.h.

#define BCAP_CLIENT_MAX   (20)

A definition for the maximum count of TCP clients.

Note

You can change this parameter to 1 or more.

Definition at line 83 of file bcap_server.h.

#define BCAP_COM_MAX   (1)

A definition for the maximum count of COM servers.

Note

You can change this parameter to 1 or more.

Definition at line 76 of file bcap_server.h.

#define BCAP_OBJECT_MAX   (1000)

A definition for the maximum count of creatable objects in a thread.

Note

You can change this parameter to 1 or more.

Definition at line 90 of file bcap_server.h.

#define BCAP_TCP_MAX   (1)

A definition for the maximum count of TCP servers.

Note

You can change this parameter to 1 or more.

Definition at line 62 of file bcap_server.h.

#define BCAP_UDP_MAX   (1)

A definition for the maximum count of UDP servers.

Note

You can change this parameter to 1 or more.

Definition at line 69 of file bcap_server.h.

#define E_BUSY_PROC   OSERR2HRESULT(ERROR_BUSY)

Failed because executing process is busy.

Definition at line 55 of file bcap_server.h.

#define ERROR_BUSY   (170L)

The requested resource because executing process is busy.

Definition at line 48 of file bcap_server.h.

#define INIT_EXEC_TIMEOUT   (180000)

A definition for the initial executing timeout.

Note

times in milliseconds.

Definition at line 97 of file bcap_server.h.

#define INIT_WDT_INTERVAL   (INFINITE)

A definition for the initial watch dog timer interval.

Note

times in milliseconds.

Definition at line 111 of file bcap_server.h.

#define KEEPALIVE_COUNT   (9)

A definition for the keep alive count option.

Definition at line 137 of file bcap_server.h.

#define KEEPALIVE_ENABLE   (1)

A definition for the keep alive enable option.

Definition at line 117 of file bcap_server.h.

#define KEEPALIVE_IDLE   (7200)

A definition for the keep alive idle option.

Note

times in seconds.

Definition at line 124 of file bcap_server.h.

#define KEEPALIVE_INTERVAL   (75)

A definition for the keep alive interval option.

Note

times in seconds.

Definition at line 131 of file bcap_server.h.

#define MIN_WDT_INTERVAL   (80)

A definition for the minimum watch dog timer interval.

Note

times in milliseconds.

Definition at line 104 of file bcap_server.h.

#define UDP_LIFELIMIT   (10000)

A definition for the life limit of a UDP connection.

Note

times in milliseconds.

Definition at line 144 of file bcap_server.h.

Typedef Documentation

typedef HRESULT(* CALL_FUNC_BCAP) (VARIANT *vntArgs, int16_t Argc, VARIANT *vntRet)

Definition at line 147 of file bcap_server.h.

Function Documentation

HRESULT bCap_Close_Server

(

int *

pfd

)

Ends b-CAP server.

Parameters

[in,out]

pfd

The pointer of File descriptor.

Definition at line 1184 of file bcap_server.c.

HRESULT bCap_Open_Server	(	const char *	connect,
		uint32_t	timeout,
		int *	pfd
	)

Starts b-CAP server.

Parameters

[in]	timeout	Timeout value.
[out]	pfd	The pointer of File descriptor.

Definition at line 1056 of file bcap_server.c.

HRESULT bCap_SetCallFunc	(	int32_t	Id,
		CALL_FUNC_BCAP	func
	)

Sets a callback function.

Parameters

[in]	id	The b-CAP function ID.
[in]	func	A callback function to be set.

Definition at line 1044 of file bcap_server.c.