client

Documentation

Index

• Variables
• type Config
• type Conn
  • func DialHub(addr string, info *Config) (*Conn, error)
  • func HubHandshake(conn *adc.Conn, conf *Config) (*Conn, error)
  • func (c *Conn) CID() adc.CID
  • func (c *Conn) Close() error
  • func (c *Conn) Features() adc.ModFeatures
  • func (c *Conn) Hub() adc.HubInfo
  • func (c *Conn) OnlinePeers() []*Peer
  • func (c *Conn) PID() adc.PID
  • func (c *Conn) SID() adc.SID
• type File
• type FileInfo
• type Peer
  • func (p *Peer) CanDial() bool
  • func (p *Peer) Dial(ctx context.Context) (*PeerConn, error)
  • func (p *Peer) Info() adc.User
  • func (p *Peer) Online() bool
• type PeerConn
  • func (c *PeerConn) Close() error
  • func (c *PeerConn) GetFile(ctx context.Context, path string) (File, error)
  • func (c *PeerConn) GetFileListBZIP(ctx context.Context) (io.ReadCloser, error)
  • func (c *PeerConn) Peer() *Peer
  • func (c *PeerConn) StatFile(ctx context.Context, path string) (FileInfo, error)
  • func (c *PeerConn) StatFileList(ctx context.Context, path string) (FileInfo, error)

Variables

var (
	ErrPeerOffline = errors.New("peer is offline")
	ErrPeerPassive = errors.New("peer is passive")
)

Types

type Config

type Config struct {
	PID        adc.PID
	Name       string
	Extensions adc.ExtFeatures
}

type Conn

type Conn struct {
	// contains filtered or unexported fields
}

Conn represents a Client-to-Hub connection.

func DialHub

func DialHub(addr string, info *Config) (*Conn, error)

DialHub connects to a hub and runs a handshake.

func HubHandshake

func HubHandshake(conn *adc.Conn, conf *Config) (*Conn, error)

HubHandshake begins a Client-Hub handshake on a connection.

func (*Conn) CID

func (c *Conn) CID() adc.CID

CID returns Client ID associated with this connection.

func (*Conn) Close

func (c *Conn) Close() error

func (*Conn) Features

func (c *Conn) Features() adc.ModFeatures

Features returns a set of negotiated features.

func (*Conn) Hub

func (c *Conn) Hub() adc.HubInfo

Hub returns hub information.

func (*Conn) OnlinePeers

func (c *Conn) OnlinePeers() []*Peer

func (*Conn) PID

func (c *Conn) PID() adc.PID

PID returns Private ID associated with this connection.

func (*Conn) SID

func (c *Conn) SID() adc.SID

SID returns Session ID associated with this connection. Only valid after a Client-Hub handshake.

type File

type File interface {
	io.Reader
	io.ReaderAt
	io.Seeker
	io.Closer
	Size() int64
	TTH() adc.TTH
}

type FileInfo

type FileInfo struct {
	Size int64
	TTH  adc.TTH
}

type Peer

type Peer struct {
	// contains filtered or unexported fields
}

func (*Peer) CanDial

func (p *Peer) CanDial() bool

func (*Peer) Dial

func (p *Peer) Dial(ctx context.Context) (*PeerConn, error)

Dial tries to dial the peer either in passive or active mode.

func (*Peer) Info

func (p *Peer) Info() adc.User

func (*Peer) Online

func (p *Peer) Online() bool

type PeerConn

type PeerConn struct {
	// contains filtered or unexported fields
}

func (*PeerConn) Close

func (c *PeerConn) Close() error

func (*PeerConn) GetFile

func (c *PeerConn) GetFile(ctx context.Context, path string) (File, error)

func (*PeerConn) GetFileListBZIP

func (c *PeerConn) GetFileListBZIP(ctx context.Context) (io.ReadCloser, error)

func (*PeerConn) Peer

func (c *PeerConn) Peer() *Peer

func (*PeerConn) StatFile

func (c *PeerConn) StatFile(ctx context.Context, path string) (FileInfo, error)

func (*PeerConn) StatFileList

func (c *PeerConn) StatFileList(ctx context.Context, path string) (FileInfo, error)