Skip to content

Commit

Permalink
Various doc cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
matzf committed Mar 24, 2020
1 parent e932502 commit 0e48735
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 6 deletions.
4 changes: 2 additions & 2 deletions go/lib/sciond/sciond.go
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@ func (s *service) Connect(ctx context.Context) (Connector, error) {
// A Connector is used to query SCIOND. All connector methods block until
// either an error occurs, or the method successfully returns.
type Connector interface {
// LocalIA is a convenience function to query the local IA, using ASInfo
// LocalIA requests from SCIOND the local ISD-AS number.
LocalIA(ctx context.Context) (addr.IA, error)
// Paths requests from SCIOND a set of end to end paths between src and
// Paths requests from SCIOND a set of end to end paths between the source and destination.
Paths(ctx context.Context, dst, src addr.IA, f PathReqFlags) ([]snet.Path, error)
// ASInfo requests from SCIOND information about AS ia.
ASInfo(ctx context.Context, ia addr.IA) (*ASInfoReply, error)
Expand Down
2 changes: 1 addition & 1 deletion go/lib/snet/addrutil/addrutil.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ func GetPath(svc addr.HostSVC, ps *seg.PathSegment, topoProv topology.Provider)
return &snet.SVCAddr{IA: ps.FirstIA(), Path: p, NextHop: overlayNextHop, SVC: svc}, nil
}

// ResolveLocal returns the local IP address used for traffic destined to dst
// ResolveLocal returns the local IP address used for traffic destined to dst.
func ResolveLocal(dst net.IP) (net.IP, error) {
udpAddr := net.UDPAddr{IP: dst, Port: 1}
udpConn, err := net.DialUDP(udpAddr.Network(), nil, &udpAddr)
Expand Down
2 changes: 1 addition & 1 deletion go/tools/scmp/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ func setPathAndMtu() {
cmn.Mtu = path.MTU()
}

// setLocalASInfo queries the local AS information from SCIOND; sets cmn.LocalIA and localMtu
// setLocalASInfo queries the local AS information from SCIOND; sets cmn.LocalIA and localMtu.
func setLocalASInfo() {
asInfo, err := sdConn.ASInfo(context.Background(), addr.IA{})
if err != nil {
Expand Down
3 changes: 1 addition & 2 deletions go/tools/showpaths/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ Alternatively, you can also run the application using:
go run paths.go -dstIA 2-ff00:0:222
```

In the examples above, the application will display the paths between 1-ff00:0:133 and
2-ff00:0:222.
In the examples above, the application will display the paths between the local AS and 2-ff00:0:222.

For complete options:

Expand Down

0 comments on commit 0e48735

Please sign in to comment.