peer

type Attribute ¶

type Attribute struct {
	Code  FileAttributeType
	Value uint32
}

Attribute is a type of file attribute.

type Code ¶ added in v1.0.0

type Code int

Code Peer messages are sent to peers over a P connection (TCP). Only a single active connection to a peer is allowed.

const CodeFileSearchResponse Code = 9

const CodeFolderContentsRequest Code = 36

const CodeFolderContentsResponse Code = 37

const CodePlaceInQueueRequest Code = 51

const CodePlaceInQueueResponse Code = 44

const CodeQueueUpload Code = 43

const CodeSharedFileListRequest Code = 4

const CodeSharedFileListResponse Code = 5

const CodeTransferRequest Code = 40

const CodeTransferResponse Code = 41

const CodeUploadDenied Code = 50

const CodeUploadFailed Code = 46

const CodeUserInfoRequest Code = 15

const CodeUserInfoResponse Code = 16

func (i Code) String() string

type CodeInit ¶ added in v1.0.0

type CodeInit int

CodeInit Peer init messages are used to initiate a P, F or D connection (TCP) to a peer.

const CodePeerInit CodeInit = 1

const CodePierceFirewall CodeInit = 0

func (i CodeInit) String() string

type Directory ¶

type Directory struct {
	Name  string
	Files []File
}

Directory is a directory in a shared file list.

type File ¶

type File struct {
	Name       string
	Size       uint64
	Extension  string
	Attributes []Attribute
}

File is a file in a directory.

type FileAttributeType ¶ added in v0.0.2

type FileAttributeType int

FileAttributeType represents the type of file attribute.

const (
	// Bitrate (kbps).
	Bitrate FileAttributeType = iota
	// Duration (seconds).
	Duration
	// VBR (0 or 1).
	VBR

	// SampleRate (Hz).
	SampleRate
	// BitDepth (bits).
	BitDepth
)

func (i FileAttributeType) String() string

type FileSearchResponse ¶ added in v1.0.0

type FileSearchResponse struct {
	Username       string
	Token          soul.Token
	Results        []File
	FreeSlot       bool
	AverageSpeed   int
	Queue          int // Queue is the length of the queued transfers.
	PrivateResults []File
}

FileSearchResponse code 9 peer sends this message when it has a file search match. The token is taken from original FileSearch, UserSearch or RoomSearch server message.

func (f *FileSearchResponse) Deserialize(reader io.Reader) error

func (f FileSearchResponse) Serialize(fs FileSearchResponse) ([]byte, error)

type Folder ¶ added in v1.0.0

type Folder struct {
	Directory string
	Files     []File
}

Folder represents a folder and its contents.

type FolderContentsRequest ¶ added in v1.0.0

type FolderContentsRequest struct {
	Token  soul.Token
	Folder string
}

FolderContentsRequest code 36 we ask the peer to send us the contents of a single folder.

func (f *FolderContentsRequest) Deserialize(reader io.Reader) error

func (FolderContentsRequest) Serialize(token soul.Token, folder string) ([]byte, error)

type FolderContentsResponse ¶ added in v1.0.0

type FolderContentsResponse struct {
	Token   soul.Token
	Folder  string
	Folders []Folder
}

FolderContentsResponse code 37 peer responds with the contents of a particular folder (with all subfolders) after we’ve sent a FolderContentsRequest.

func (f *FolderContentsResponse) Deserialize(reader io.Reader) error

func (FolderContentsResponse) Serialize(token soul.Token, folder string, folders []Folder) ([]byte, error)

type PeerInit ¶ added in v0.0.2

type PeerInit struct {
	// RemoteUsername is the username of the peer that wants to connect to us.
	RemoteUsername string
	ConnectionType soul.ConnectionType
}

PeerInit code 1 message is sent to initiate a direct connection to another peer.

func (p *PeerInit) Deserialize(reader io.Reader) error

func (PeerInit) Serialize(ownUsername string, connType soul.ConnectionType) ([]byte, error)

type PierceFirewall ¶ added in v0.0.2

type PierceFirewall struct {
	Token soul.Token
}

PierceFirewall code 0 message is sent in response to an indirect connection request from another user. If the message goes through to the user, the connection is ready. The token is taken from the ConnectToPeer server message.

func (p *PierceFirewall) Deserialize(reader io.Reader) error

func (PierceFirewall) Serialize(token soul.Token) ([]byte, error)

type PlaceInQueueRequest ¶ added in v1.0.0

type PlaceInQueueRequest struct {
	Filename string
}

PlaceInQueueRequest code 51 message is sent when asking for the upload queue placement of a file.

func (p *PlaceInQueueRequest) Deserialize(reader io.Reader) error

func (PlaceInQueueRequest) Serialize(filename string) ([]byte, error)

type PlaceInQueueResponse ¶ added in v1.0.0

type PlaceInQueueResponse struct {
	Filename string
	Place    uint32
}

PlaceInQueueResponse code 44 peer replies with the upload queue placement of the requested file.

func (p *PlaceInQueueResponse) Deserialize(reader io.Reader) error

func (PlaceInQueueResponse) Serialize(filename string, place uint32) ([]byte, error)

type QueueUpload ¶ added in v1.0.0

type QueueUpload struct {
	Filename string
}

QueueUpload code 43 this message is used to tell a peer that an upload should be queued on their end. Once the recipient is ready to transfer the requested file, they will send a TransferRequest to us.

func (q *QueueUpload) Deserialize(reader io.Reader) error

func (QueueUpload) Serialize(filename string) ([]byte, error)

type SharedFileListRequest ¶

type SharedFileListRequest struct{}

func (s *SharedFileListRequest) Deserialize(reader io.Reader) error

func (SharedFileListRequest) Serialize() ([]byte, error)

type SharedFileListResponse ¶

type SharedFileListResponse struct {
	Directories        []Directory
	PrivateDirectories []Directory
}

SharedFileListResponse code 5 peer responds with a list of shared files after we’ve sent a SharedFileListRequest.

func (s *SharedFileListResponse) Deserialize(reader io.Reader) error

func (s SharedFileListResponse) Serialize(directories, privateDirectories []Directory) ([]byte, error)

type TransferDirection ¶ added in v0.0.2

type TransferDirection int

TransferDirection represents the direction of a file transfer.

const (
	// DownloadFromPeer transfer direction.
	DownloadFromPeer TransferDirection = iota
	// UploadToPeer transfer direction.
	UploadToPeer
)

func (i TransferDirection) String() string

type TransferRequest ¶ added in v1.0.0

type TransferRequest struct {
	Direction TransferDirection
	Token     soul.Token
	Filename  string
	FileSize  uint64
}

TransferRequest code 40 this message is sent by a peer once they are ready to start uploading a file to us. A TransferResponse message is expected from the recipient, either allowing or rejecting the upload attempt.

This message was formerly used to send a download request (direction 0) as well, but Nicotine+ >= 3.0.3, Museek+ and the official clients use the QueueUpload peer message for this purpose today.

func (t *TransferRequest) Deserialize(reader io.Reader) error

func (TransferRequest) Serialize(direction TransferDirection, token soul.Token, filename string, filesize uint64) ([]byte, error)

type TransferResponse ¶ added in v1.0.0

type TransferResponse struct {
	Token   soul.Token
	Allowed bool
	Reason  error
}

TransferResponse code 41 response to TransferRequest. We (or the other peer) either agrees, or tells the reason for rejecting the file upload.

func (t *TransferResponse) Deserialize(reader io.Reader) error

func (TransferResponse) Serialize(token soul.Token, allowed bool, reason ...error) ([]byte, error)

type UploadDenied ¶ added in v1.0.0

type UploadDenied struct {
	Filename string
	Reason   error
}

UploadDenied code 50 this message is sent to reject QueueUpload attempts and previously queued files. The reason for rejection will appear in the transfer list of the recipient.

func (u *UploadDenied) Deserialize(reader io.Reader) error

func (UploadDenied) Serialize(filename string, reason error) ([]byte, error)

type UploadFailed ¶ added in v1.0.0

type UploadFailed struct {
	Filename string
}

UploadFailed code 46 this message is sent whenever a file connection of an active upload closes. Soulseek NS clients can also send this message when a file cannot be read. The recipient either re-queues the upload (download on their end), or ignores the message if the transfer finished.

func (u *UploadFailed) Deserialize(reader io.Reader) error

func (UploadFailed) Serialize(filename string) ([]byte, error)

type UploadPermission ¶ added in v0.0.2

type UploadPermission int

UploadPermission represents the permission level for uploading files.

const (
	// NoOne permission level.
	NoOne UploadPermission = iota
	// Everyone permission level.
	Everyone
	// UsersInList permission level.
	UsersInList
	// PermittedUsers permission level.
	PermittedUsers
)

func (i UploadPermission) String() string

type UserInfoRequest ¶ added in v1.0.0

type UserInfoRequest struct{}

func (u *UserInfoRequest) Deserialize(reader io.Reader) error

func (UserInfoRequest) Serialize() ([]byte, error)

type UserInfoResponse ¶ added in v1.0.0

type UserInfoResponse struct {
	Description     string
	Picture         []byte
	TotalUpload     uint32
	QueueSize       uint32
	FreeSlots       bool
	UploadPermitted UploadPermission
}

func (u *UserInfoResponse) Deserialize(reader io.Reader) error

func (UserInfoResponse) Serialize(u UserInfoResponse) ([]byte, error)