aboutsummaryrefslogtreecommitdiffstats
path: root/src/cyn-protocol.h
blob: 65a69d11d18e3e67afbc0d9e212c1e30615439e2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/*
 * Copyright (C) 2018 "IoT.bzh"
 * Author José Bollo <jose.bollo@iot.bzh>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#pragma once
/******************************************************************************/
/******************************************************************************/
/* IMPLEMENTATION OF COMMON PROTOCOL VALUES, CONSTANTS, PROCESSES             */
/******************************************************************************/
/******************************************************************************/

/* predefined protocol strings */
extern const char
	_ack_[],
	_agent_[],
	_ask_[],
	_check_[],
	_clear_[],
	_commit_[],
	_cynagora_[],
	_done_[],
	_drop_[],
	_enter_[],
	_error_[],
	_get_[],
	_item_[],
	_leave_[],
	_log_[],
	_no_[],
	_off_[],
	_on_[],
	_reply_[],
	_rollback_[],
	_set_[],
	_sub_[],
	_test_[],
	_yes_[];

/* predefined names */
extern const char
	cyn_default_socket_scheme[],
	cyn_default_socket_dir[],
	cyn_default_check_socket_base[],
	cyn_default_admin_socket_base[],
	cyn_default_agent_socket_base[],
	cyn_default_check_socket_spec[],
	cyn_default_admin_socket_spec[],
	cyn_default_agent_socket_spec[];

/**
 * Get the socket specification for check usage
 *
 * @param value some value or NULL for getting default
 * @return the socket specification for check usage
 */
extern
const char *
cyn_get_socket_check(
	const char *value
);

/**
 * Get the socket specification for admin usage
 *
 * @param value some value or NULL for getting default
 * @return the socket specification for admin usage
 */
extern
const char *
cyn_get_socket_admin(
	const char *value
);

/**
 * Get the socket specification for agent usage
 *
 * @param value some value or NULL for getting default
 * @return the socket specification for agent usage
 */
extern
const char *
cyn_get_socket_agent(
	const char *value
);