reference.rst
1 :tocdepth: 4 2 3 .. _api-main: 4 5 ************* 6 API Reference 7 ************* 8 Communication over Reticulum networks is achieved by using a simple set of classes exposed by the RNS API. 9 This chapter lists and explains all classes exposed by the Reticulum Network Stack API, along with their method signatures and usage. It can be used as a reference while writing applications that utilise Reticulum, or it can be read in entirity to gain an understanding of the complete functionality of RNS from a developers perspective. 10 11 .. _api-reticulum: 12 13 .. only:: html 14 15 |start-h3| Reticulum |end-h3| 16 17 .. only:: latex 18 19 Reticulum 20 --------- 21 22 .. autoclass:: RNS.Reticulum 23 :members: 24 25 26 .. _api-identity: 27 28 .. only:: html 29 30 |start-h3| Identity |end-h3| 31 32 .. only:: latex 33 34 Identity 35 -------- 36 37 .. autoclass:: RNS.Identity 38 :members: 39 40 .. _api-destination: 41 42 .. only:: html 43 44 |start-h3| Destination |end-h3| 45 46 .. only:: latex 47 48 Destination 49 ----------- 50 51 .. autoclass:: RNS.Destination 52 :members: 53 54 .. _api-packet: 55 56 .. only:: html 57 58 |start-h3| Packet |end-h3| 59 60 .. only:: latex 61 62 Packet 63 ------ 64 65 .. autoclass:: RNS.Packet(destination, data, create_receipt = True) 66 :members: 67 68 .. _api-packetreceipt: 69 70 .. only:: html 71 72 |start-h3| Packet Receipt |end-h3| 73 74 .. only:: latex 75 76 Packet Receipt 77 -------------- 78 79 .. autoclass:: RNS.PacketReceipt() 80 :members: 81 82 .. _api-link: 83 84 .. only:: html 85 86 |start-h3| Link |end-h3| 87 88 .. only:: latex 89 90 Link 91 ---- 92 93 .. autoclass:: RNS.Link(destination, established_callback=None, closed_callback = None) 94 :members: 95 96 .. _api-requestreceipt: 97 98 .. only:: html 99 100 |start-h3| Request Receipt |end-h3| 101 102 .. only:: latex 103 104 Request Receipt 105 --------------- 106 107 .. autoclass:: RNS.RequestReceipt() 108 :members: 109 110 .. _api-resource: 111 112 .. only:: html 113 114 |start-h3| Resource |end-h3| 115 116 .. only:: latex 117 118 Resource 119 -------- 120 121 .. autoclass:: RNS.Resource(data, link, advertise=True, auto_compress=True, callback=None, progress_callback=None, timeout=None) 122 :members: 123 124 .. _api-channel: 125 126 .. only:: html 127 128 |start-h3| Channel |end-h3| 129 130 .. only:: latex 131 132 Channel 133 ------- 134 135 .. autoclass:: RNS.Channel.Channel() 136 :members: 137 138 .. _api-messsagebase: 139 140 .. only:: html 141 142 |start-h3| MessageBase |end-h3| 143 144 .. only:: latex 145 146 MessageBase 147 ----------- 148 149 .. autoclass:: RNS.MessageBase() 150 :members: 151 152 .. _api-buffer: 153 154 .. only:: html 155 156 |start-h3| Buffer |end-h3| 157 158 .. only:: latex 159 160 Buffer 161 ------ 162 163 .. autoclass:: RNS.Buffer 164 :members: 165 166 .. _api-rawchannelreader: 167 168 .. only:: html 169 170 |start-h3| RawChannelReader |end-h3| 171 172 .. only:: latex 173 174 RawChannelReader 175 ---------------- 176 177 .. autoclass:: RNS.RawChannelReader 178 :members: __init__, add_ready_callback, remove_ready_callback 179 180 .. _api-rawchannelwriter: 181 182 .. only:: html 183 184 |start-h3| RawChannelWriter |end-h3| 185 186 .. only:: latex 187 188 RawChannelWriter 189 ---------------- 190 191 .. autoclass:: RNS.RawChannelWriter 192 :members: __init__ 193 194 .. _api-transport: 195 196 .. only:: html 197 198 |start-h3| Transport |end-h3| 199 200 .. only:: latex 201 202 Transport 203 --------- 204 205 .. autoclass:: RNS.Transport 206 :members: 207 208 .. |start-h3| raw:: html 209 210 <h3> 211 212 .. |end-h3| raw:: html 213 214 </h3>