Documentation/networking/tipc.rst

1 .. SPDX-License-Identifier: GPL-2.0
10 TIPC (Transparent Inter Process Communication) is a protocol that is specially
11 designed for intra-cluster communication. It can be configured to transmit
14 than with any other known protocol, while maximal throughput is comparable to
18 -------------
20 - Cluster wide IPC service
32 - Service Addressing
38 - Service Tracking
45   i.e., subscribing for availability/non-availability of cluster nodes.
51 - Transmission Modes
64 - Inter Node Links
67   Inter Node Links, which both guarantee data traffic integrity and monitor
68   the peer node's availability.
70 - Cluster Scalability
72   By applying the Overlapping Ring Monitoring algorithm on the inter node links
74   neighbor failure discovery time of 1-2 seconds. For smaller clusters this
77 - Neighbor Discovery
79   Neighbor Node Discovery in the cluster is done by Ethernet broadcast or UDP
83 - Configuration
85   When running TIPC in single node mode no configuration whatsoever is needed.
86   When running in cluster mode TIPC must as a minimum be given a node address
91 - Performance
93   TIPC message transfer latency times are better than in any other known protocol.
94   Maximal byte throughput for inter-node connections is still somewhat lower than
95   for TCP, while they are superior for intra-node and inter-container throughput
98 - Language Support
103 ----------------
105 - How to set up TIPC:
109 - How to program with TIPC:
113 - How to contribute to TIPC:
115 - http://tipc.io/contacts.html
117 - More details about TIPC specification:
119   http://tipc.io/protocol.html
128 ---------------
130 .. kernel-doc:: net/tipc/subscr.h
133 .. kernel-doc:: net/tipc/bearer.h
136 .. kernel-doc:: net/tipc/name_table.h
139 .. kernel-doc:: net/tipc/name_distr.h
142 .. kernel-doc:: net/tipc/bcast.c
146 ----------------------
148 .. kernel-doc:: net/tipc/bearer.c
151 .. kernel-doc:: net/tipc/udp_media.c
155 ----------------------
157 .. kernel-doc:: net/tipc/crypto.c
161 --------------------------
163 .. kernel-doc:: net/tipc/discover.c
167 --------------------
169 .. kernel-doc:: net/tipc/link.c
173 -------------------
175 .. kernel-doc:: net/tipc/msg.c
179 --------------------
181 .. kernel-doc:: net/tipc/name_table.c
184 .. kernel-doc:: net/tipc/name_distr.c
187 TIPC Node Management Interfaces
188 -------------------------------
190 .. kernel-doc:: net/tipc/node.c
194 ----------------------
196 .. kernel-doc:: net/tipc/socket.c
200 --------------------------------
202 .. kernel-doc:: net/tipc/subscr.c
206 ----------------------
208 .. kernel-doc:: net/tipc/topsrv.c
212 ---------------------
214 .. kernel-doc:: net/tipc/trace.c