b10-msgq.8 2.85 KB
Newer Older
1
'\" t
2
.\"     Title: b10-msgq
3
4
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
Jeremy C. Reed's avatar
Jeremy C. Reed committed
5
.\"      Date: June 25, 2012
6
7
8
9
.\"    Manual: BIND10
.\"    Source: BIND10
.\"  Language: English
.\"
Jeremy C. Reed's avatar
Jeremy C. Reed committed
10
.TH "B10\-MSGQ" "8" "June 25, 2012" "BIND10" "BIND10"
11
12
13
14
15
16
17
18
19
20
21
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
22
b10-msgq \- message routing daemon for the Command Channel
23
.SH "SYNOPSIS"
24
.HP \w'\fBb10\-msgq\fR\ 'u
25
\fBb10\-msgq\fR [\fB\-s\ \fR\fB\fIfile\fR\fR] [\fB\-v\fR] [\fB\-\-socket\-file\ \fR\fB\fIfile\fR\fR] [\fB\-\-verbose\fR]
26
27
.SH "DESCRIPTION"
.PP
Jeremy C. Reed's avatar
Jeremy C. Reed committed
28
The
29
\fBb10\-msgq\fR
30
31
daemon provides message routing for the Command Channel\&.
.PP
32
33
The Command Channel is a message bus and subscription manager\&. Programs may subscribe to certain groups to receive messages for that group\&. Every new connection to
\fBb10\-msgq\fR
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
is assigned a unique identifier \-\- this is the local name\&. The commands it handles are:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBgetlname\fR
\(em receive local name\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBsend\fR
\(em send a message to defined subscribers\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBsubscribe\fR
\(em add a subscription\&. This means it is a listener for messages for a specific group\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

\fBunsubscribe\fR
\(em remove a subscription\&.
.RE
.sp
.RE
.PP
The
91
\fBb10\-msgq\fR
92
93
94
daemon may be cleanly stopped by sending the SIGTERM signal to the process\&. This shutdown does not notify the subscribers\&.
.SH "OPTIONS"
.PP
Jeremy C. Reed's avatar
Jeremy C. Reed committed
95
The arguments are as follows:
96
.PP
97
\fB\-s \fR\fB\fIfile\fR\fR, \fB\-\-socket\-file \fR\fB\fIfile\fR\fR
98
.RS 4
99
100
The UNIX domain socket file this daemon will use\&. The default is
/usr/local/var/bind10\-devel/msg_socket\&.
101
102
103
104
105
.RE
.PP
\fB\-v\fR, \fB\-\-verbose\fR
.RS 4
Enabled verbose mode\&. This enables diagnostic messages to STDERR\&. Displays more about what
106
\fBb10\-msgq\fR
107
108
109
110
111
112
is doing\&.
.RE
.SH "SEE ALSO"
.PP

\fBbind10\fR(8),
Jeremy C. Reed's avatar
Jeremy C. Reed committed
113
BIND 10 Guide\&.
114
115
.SH "AUTHORS"
.PP
Jeremy C. Reed's avatar
Jeremy C. Reed committed
116
The
117
\fBb10\-msgq\fR
118
119
120
121
122
123
124
125
daemon and Control Channel specification were initially designed by Michael Graff of ISC\&.
.SH "HISTORY"
.PP
The python version was first coded in December 2009\&. The C version with now deprecated wire format was coded in September 2009\&.
.SH "COPYRIGHT"
.br
Copyright \(co 2010 Internet Systems Consortium, Inc. ("ISC")
.br