/
go-graphsync.puml
232 lines (190 loc) · 5.67 KB
/
go-graphsync.puml
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
@startuml "GraphSync"
package "go-ipld-prime" {
interface Node {
}
interface NodeBuilder {
}
interface Path {
}
interface Link
package traversal {
package selector {
interface Selector {
}
object "PackagePublicFunctions" as goSelectorPF {
ReifySelector(cidRootedSelector Node) (Selector, error)
}
}
interface AdvVisitFn {
}
class TraversalConfig {
}
class TraversalProgress {
TraverseInformatively(Node, Selector, AdvVisitFn)
}
TraversalProgress *-- TraversalConfig
}
interface Loader {
}
}
package "go-graphsync" {
class ResponseProgress {
Node ipld.Node
Path ipld.Path
LastBlock struct {
ipld.Node
ipld.Link }
}
interface Cid2BlockFn {
}
class GraphSync {
Request(ctx context.Context, p peer.ID, rootedSelector Node) (chan ResponseProgress, chan error)
GetBlocks(ctx context.Context, p peer.ID, rootedSelector Node) (chan blocks.Block, chan error)
ReceiveMessage(ctx context.Context, sender peer.ID, incoming GraphSyncMessage)
ReceiveError(error)
}
GraphSync *-- RawLoader
package network {
interface Receiver {
ReceiveMessage(ctx context.Context, sender peer.ID, incoming GraphSyncMessage)
ReceiveError(error)
}
interface GraphSyncNetwork {
SendMessage(ctx context.Context, receiver peer.Id, m GraphSyncMessage)
SetDelegate(receiver Receiver)
ConnectTo(ctx context.Context, peer.ID) error
NewMessageSender(context.Context, peer.ID) (MessageSender, error)
}
interface MessageSender {
SendMsg(context.Context, GraphSyncMessage) error
Close() error
Reset() error
}
Receiver <|-- GraphSync : receiver for
class libP2PGraphSyncNetwork {
}
GraphSyncNetwork <|-- libP2PGraphSyncNetwork
object "Package Public Functions" as goGraphSyncNetworkPF {
NewLibP2PNetwork(host libp2pHost.Host) GraphSyncNetwork
}
goGraphSyncNetworkPF .. libP2PGraphSyncNetwork
}
package messagequeue {
class MessageQueue {
AddRequest(GraphSyncRequest)
Cancel(GraphSyncRequestID)
Startup()
Shutdown()
}
object "PackagePublicFunctions" as goMessageQueuePF {
New(context.Context, peer.ID, GraphSyncNetwork) *MessageQueue
}
GraphSync .. goMessageQueuePF
MessageQueue *-- GraphSyncNetwork
}
package peerhandler {
class PeerManager {
Connected(p peer.ID)
Disconnected(p peer.ID)
ConnectedPeers() []peer.ID
SendRequest(peer.ID, GraphSyncRequest)
}
object "Package Public Functions" as goPeerManagerPF {
New(ctx context.Context, createPeerQueue func(context, peer.ID) MessageQueue)
}
GraphSync .. goPeerManagerPF
PeerManager *-- MessageQueue
}
package requestmanager {
interface ResponseProgress {
}
interface ResponseError {
}
class RequestManager {
SetDelegate(peerHandler PeerManager)
SendRequest(ctx context.Context, p peer.ID, cidRootedSelector Node) chan Block
ProcessResponses(message GraphSyncMessage)
}
RequestManager *-- PeerManager
GraphSync *-- RequestManager
}
package responsemanager {
class ResponseManager {
ProcessRequests(p peer.ID, requests []GraphSyncRequests)
}
ResponseManager *-- GraphSyncNetwork
GraphSync *-- ResponseManager
ResponseManager *-- RawLoader
}
package message {
object "Package Public Functions" as goGraphSyncMessagePF {
func FromPBReader(pbr ggio.Reader) (GraphSyncMessage, error)
func FromNet(r io.Reader) (GraphSyncMessage, error)
}
goGraphSyncMessagePF .. libP2PGraphSyncNetwork
interface GraphSyncRequest {
Selector() []bytes
Priority() Priority
ID() int
IsCancel() bool
}
interface GraphSyncResponse {
RequestID() int
Status() GraphSyncStatus
Extra() []bytes
}
interface GraphSyncMessage {
Requests() : []GraphSyncRequest
Responses() : []GraphSyncResponse
Blocks() : []Blocks
}
interface Exportable {
ToProto()
ToNet(w io.Writer) error
}
Exportable --|> GraphSyncMessage
GraphSyncRequest --* GraphSyncMessage
GraphSyncResponse --* GraphSyncMessage
}
package ipldbridge {
interface IPLDBridge {
ValidateSelectorSpec(rootedSelector ipld.Node) []error
EncodeNode(ipld.Node) ([]byte, error)
DecodeNode([]byte) (ipld.Node, error)
DecodeSelectorSpec(cidRootedSelector ipld.Node) (ipld.Node, Selector, error)
Traverse(ctx context.Context, loader Loader, root ipld.Node, s Selector, fn AdvVisitFn) error
}
GraphSync *-- IPLDBridge
RequestManager *-- IPLDBridge
ResponseManager *-- IPLDBridge
class ipldBridge {
}
object "PackagePublicFunctions" as goIPLDBridge {
NewIPLDBridge() IPLDBridge
}
IPLDBridge <|-- ipldBridge
goIPLDBridge .. ipldBridge
ipldBridge *-- MulticodecDecodeTable
ipldBridge *-- NodeBuilderChooser
ipldBridge .. TraversalProgress
ipldBridge .. goSelectorPF
ipldBridge .. goIPLDReposePf
}
object "PackagePublicFunctions" as goGraphsyncPf {
New(ctx context.Context, network GraphSyncNetwork, ipldBridge IPLDBridge, loader Loader) GraphSync
LoaderFromCid2BlockFn(cid2BlockFn Cid2BlockFn) Loader
SelectorSpecFromCidAndPath(lnk cid.Cid, pathSegments []string) (ipld.Node, error)
}
}
package "go-filecoin" {
class "go-filecoin" {
}
"go-filecoin" *-- GraphSync
"go-filecoin" .. goGraphsyncPf
"go-filecoin" .. goGraphSyncNetworkPF
"go-filecoin" .. goIPLDBridge
"go-filecoin" *-- RawLoader
"go-filecoin" *-- MulticodecDecodeTable
"go-filecoin" *-- NodeBuilderChooser
}
@enduml