Skip to content

NetworkDocumentation.md

Latest commit

 

History

History
84 lines (65 loc) · 3.12 KB

NetworkDocumentation.md

File metadata and controls

84 lines (65 loc) · 3.12 KB

KAI Network Documentation

Central index for all networking documentation.

Architecture

graph LR
    TAU[Tau IDL<br/>.tau files] -->|NetworkGenerate| GEN[Generated<br/>proxy.h / agent.h]
    GEN --> PROXY[Proxy&lt;T&gt;<br/>client stub]
    GEN --> AGENT[Agent&lt;T&gt;<br/>server handler]
    PROXY -->|ENet UDP| AGENT
    AGENT --> NODE[Node<br/>network endpoint]
    PROXY --> NODE
    NODE --> DOMAIN[Domain<br/>node grouping]
Loading

Documents

Document Contents
PeerToPeerNetworking.md Node/Domain/Agent/Proxy architecture, wire protocol, quick-start
TauTutorial.md Tau IDL syntax for defining network interfaces
NetworkSecurity.md Security considerations and future plans
NetworkIteration.md Distributed iteration patterns
NetworkCalculationTest.md Example distributed calculation

Core Components

Header Purpose
KAI/Network/Node.h Network endpoint — listen, connect, send, receive
KAI/Network/Domain.h Groups a Node with MakeAgent<T>() / MakeProxy<T>()
KAI/Network/Agent.h Server-side object; BindMethod, BindMemberProperty
KAI/Network/Proxy.h Client-side stub; Call<R>(), Get<P>(), Set<P>()
KAI/Network/ProxyBase.h Base for proxies: Exec, Fetch, Store
KAI/Network/AgentBase.h Base for agents: registers handle with Node
KAI/Network/Future.h Async result type returned by all remote calls
KAI/Network/Transport.h SendReliability, SendRouting, BufferOffset enums
KAI/Network/Serialization.h Wire message IDs and serialization helpers

Build

Networking is off by default:

./b --network          # build with ENet, Tau IDL, NetworkGenerate, network tests
./b --network --clean  # clean rebuild with networking

cmake .. -DKAI_NETWORKING=ON   # equivalent CMake flag

The KAI_NETWORKING option controls:

  • ENet library
  • Network library
  • TauLang (needed for IDL code generation)
  • NetworkGenerate executable
  • Test_Network test binary
  • TestTau language tests

Running Network Tests

./Bin/Test/Test_Network                                     # all 17 tests
./Bin/Test/Test_Network --gtest_filter="NodeEndToEndTest*"  # 6 E2E tests
./Bin/Test/Test_Network --gtest_filter="TauDomain*"         # 3 domain tests

FAQ

Q: Is KAI networking peer-to-peer or client-server? Symmetric P2P — every Node can both listen and connect. Roles (agent = server, proxy = client) are per-object, not per-node.

Q: What transport is used? ENet over UDP (reliable and unreliable channels both supported via SendReliability enum).

Q: How do I expose a C++ method over the network? Create an Agent<MyClass>, call BindMethod("Name", &MyClass::Method). The other side creates a Proxy<MyClass> and calls proxy.Call<ReturnType>("Name", args...).

Q: How do I generate proxy/agent from a .tau file?

./Bin/NetworkGenerate MyInterface.tau
# produces MyInterface.proxy.h and MyInterface.agent.h