dctk

type Client struct {

	// OnInitialized is called just after client initialization, before connecting to the hub
	OnInitialized func()
	// OnShareIndexed is called every time the share indexer has finished indexing the client share
	OnShareIndexed func()
	// OnHubConnected is called when the connection between client and hub has been established
	OnHubConnected func()
	// OnHubError is called when a critical error happens
	OnHubError func(err error)
	// OnHubInfo is called when an information about the hub is received
	OnHubInfo func(field HubField, value string)
	// OnHubTLS is called when a TLS connection with a hub is established
	OnHubTLS func(st tls.ConnectionState)
	// OnHubProto is called when a protocol for the hub is selected
	OnHubProto func(proto string)
	// OnPeerConnected is called when a peer connects to the hub
	OnPeerConnected func(p *Peer)
	// OnPeerUpdated is called when a peer has just updated its informations
	OnPeerUpdated func(p *Peer)
	// OnPeerDisconnected is called when a peer disconnects from the hub
	OnPeerDisconnected func(p *Peer)
	// OnMessagePublic is called when someone writes in the hub public chat.
	// When using ADC, it is also called when the hub sends a message.
	OnMessagePublic func(p *Peer, content string)
	// OnMessagePrivate is called when a private message has been received
	OnMessagePrivate func(p *Peer, content string)
	// OnSearchResult is called when a search result has been received
	OnSearchResult func(r *SearchResult)
	// OnDownloadSuccessful is called when a given download has finished
	OnDownloadSuccessful func(d *Download)
	// OnDownloadError is called when a given download has failed
	OnDownloadError func(d *Download)
	// contains filtered or unexported fields
}

type ClientConf struct {
	// verbosity of the library
	LogLevel log.Level

	// turns on passive mode: it is not necessary anymore to open TCPPort, UDPPort
	// and TLSPort but functionalities are limited
	IsPassive bool
	// (optional) an explicit ip, instead of the one obtained automatically
	IP string
	// these are the 3 ports needed for active mode. They must be accessible from the
	// internet, so any router/firewall in between must be configured
	TCPPort uint
	UDPPort uint
	TLSPort uint

	// the maximum number of file to download in parallel. When this number is
	// exceeded, the other downloads are queued and started when a slot becomes available
	DownloadMaxParallel uint
	// the maximum number of file to upload in parallel
	UploadMaxParallel uint

	// set the policy regarding encryption with other peers. See EncryptionMode for options
	PeerEncryptionMode EncryptionMode

	// The hub url in the format protocol://address:port
	// supported protocols are adc, adcs, nmdc and nmdcs
	HubURL string
	// how many times attempting a connection with hub before giving up
	HubConnTries uint
	// if turned on, connection to hub is not automatic and HubConnect() must be
	// called manually
	HubManualConnect bool

	// the nickname to use in the hub and with other peers
	Nick string
	// the password associated with the nick, if requested by the hub
	Password string
	// the private ID of the user (ADC only)
	PID atypes.PID
	// an email, optional
	Email string
	// a description, optional
	Description string
	// the maximum upload speed in bytes/sec. It is not really applied, but is sent to the hub
	UploadMaxSpeed uint
	// these are used to identify the software. By default they mimic DC++
	ClientString  string
	ClientVersion string
	PkValue       string
	ListGenerator string

	// options useful only for debugging purposes
	HubDisableCompression  bool
	PeerDisableCompression bool
	HubDisableKeepAlive    bool
}

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

type DownloadConf struct {
	// the peer from which downloading
	Peer *Peer
	// the TTH of the file to download
	TTH tiger.Hash
	// the starting point of the file part to download, in bytes
	Start uint64
	// the length of the file part. Leave zero to download the entire file
	Length int64
	// if filled, the file is saved on the desired path on disk, otherwise it is kept on RAM
	SavePath string
	// after download, do not attempt to validate the file through its TTH
	SkipValidation bool
	// contains filtered or unexported fields
}

type EncryptionMode int

type FileList struct {
	XMLName   xml.Name             `xml:"FileListing"`
	Version   string               `xml:"Version,attr"`
	CID       string               `xml:"CID,attr"`
	Base      string               `xml:"Base,attr"`
	Generator string               `xml:"Generator,attr"`
	Dirs      []*FileListDirectory `xml:"Directory"`
}

type FileListDirectory struct {
	Name  string               `xml:"Name,attr"`
	Files []*FileListFile      `xml:"File"`
	Dirs  []*FileListDirectory `xml:"Directory"`
}

type FileListFile struct {
	Name string     `xml:"Name,attr"`
	Size uint64     `xml:"Size,attr"`
	TTH  tiger.Hash `xml:"TTH,attr"`
}

type HubField string

type Peer struct {
	// peer nickname
	Nick string
	// peer description (if provided)
	Description string
	// peer email (if provided)
	Email string
	// whether peer is a bot
	IsBot bool
	// whether peer is a operator
	IsOperator bool
	// client used by peer (in NMDC this could be hidden)
	Client string
	// version of client (in NMDC this could be hidden)
	Version string
	// overall size of files shared by peer
	ShareSize uint64
	// whether peer is in passive mode (in NMDC this could be hidden)
	IsPassive bool
	// peer ip (if provided by both peer and hub)
	IP string
	// contains filtered or unexported fields
}

type SearchConf struct {
	// the search type, defaults to SearchAny. See SearchType for all the available options
	Type SearchType
	// the minimum size of the searched file (if type is SearchAny or SearchTTH)
	MinSize uint64
	// the maximum size of the searched file (if type is SearchAny or SearchTTH)
	MaxSize uint64
	// part of a file name (if type is SearchAny), part of a directory name
	// (if type is SearchAny or SearchDirectory)
	Query string
	// file TTH (if type is SearchTTH)
	TTH tiger.Hash
}

type SearchResult struct {
	// whether the search result was received in passive or active mode
	IsActive bool
	// the peer sending the result
	Peer *Peer
	// path of a file or directory matching a search request
	Path string
	// whether the result is a directory
	IsDir bool
	// size (file only in NMDC, both files and directories in ADC)
	Size uint64
	// TTH (file only)
	TTH *tiger.Hash
	// the available upload slots of the peer
	SlotAvail uint
}

type SearchType int