Nicotine+

Soulseek Protocol Documentation

Last updated on November 2, 2021

Since the official Soulseek client and server is proprietary software, this documentation has been compiled thanks to years of reverse engineering efforts. To preserve the health of the Soulseek network, please do not modify the protocol in ways that negatively impact the network.

If you find any inconsistencies or errors in the documentation, please report them.

Sections

• Packing
• Constants
• Server Messages
• Peer Init Messages
• Peer Messages
• File Messages
• Distributed Messages
• Museek Data Types

Packing

String

Length of String	String
4 Byte	String

Integer

Number
4 Byte

Large Integer

Number
8 Byte

Bool

Character
1 Byte

Constants

Connection Types

Type	Connection
P	Peer To Peer
F	File Transfer
D	Distributed Network

Status Codes

Code	Status
-1	Unknown
0	Offline
1	Away
2	Online

Transfer Direction

Code	Type
0	Download
1	Upload

Server Messages

Send	Receive
Send to Server	Receive from Server

These messages are used by clients to interface with the server. Internal Server messages are spooky and not understood, since the OSS crowd doesn’t have access to its source code. If you want a Soulseek server, check out Soulfind. Soulfind is obviously not the exact same the official Soulseek server, but it handles the protocol well enough (and can be modified).

In museekd 0.1.13, these messages are sent and received in Museek/ServerConnection.cc and defined in Museek/ServerMessages.hh. Since museekd 0.2, they are defined in museekd/servermessages.h.

In Nicotine, these messages are matched to their message number in slskproto.py in the SlskProtoThread function, defined in slskmessages.py and callbacks for the messages are set in pynicotine.py.

Server Message Format

Message Length	Code	Message Contents
4 Bytes	4 Bytes	…

Message Index

Code	Message	Status
1	Login
2	Set Listen Port
3	Get Peer Address
5	Add User
6	Remove User
7	Get Status
13	Say in Chat Room
14	Join Room
15	Leave Room
16	User Joined Room
17	User Left Room
18	Connect To Peer
22	Private Messages
23	Acknowledge Private Message
26	File Search
28	Set Online Status
32	Ping	Deprecated
33	Send Connect Token	Obsolete
34	Send Download Speed	Obsolete
35	Shared Folders & Files
36	Get User Stats
40	Queued Downloads	Obsolete
41	Kicked from Server
42	User Search
51	Interest Add	Deprecated
52	Interest Remove	Deprecated
54	Get Recommendations	Deprecated
56	Get Global Recommendations	Deprecated
57	Get User Interests	Deprecated
58	Admin Command	Obsolete
60	Place In Line Response	Obsolete
62	Room Added	Obsolete
63	Room Removed	Obsolete
64	Room List
65	Exact File Search	Obsolete
66	Global/Admin Message
67	Global User List	Obsolete
68	Tunneled Message	Obsolete
69	Privileged Users
71	Have No Parents
73	Parent’s IP	Deprecated
83	Parent Min Speed
84	Parent Speed Ratio
86	Parent Inactivity Timeout	Obsolete
87	Search Inactivity Timeout	Obsolete
88	Minimum Parents In Cache	Obsolete
90	Distributed Alive Interval	Obsolete
91	Add Privileged User	Obsolete
92	Check Privileges
93	Embedded Message
100	Accept Children
102	Possible Parents
103	Wishlist Search
104	Wishlist Interval
110	Get Similar Users	Deprecated
111	Get Item Recommendations	Deprecated
112	Get Item Similar Users	Deprecated
113	Room Tickers
114	Room Ticker Add
115	Room Ticker Remove
116	Set Room Ticker
117	Hated Interest Add	Deprecated
118	Hated Interest Remove	Deprecated
120	Room Search
121	Send Upload Speed
122	User Privileges	Deprecated
123	Give Privileges
124	Notify Privileges	Deprecated
125	Acknowledge Notify Privileges	Deprecated
126	Branch Level
127	Branch Root
129	Child Depth
130	Reset Distributed
133	Private Room Users
134	Private Room Add User
135	Private Room Remove User
136	Private Room Drop Membership
137	Private Room Drop Ownership
138	Private Room Unknown	Obsolete
139	Private Room Added
140	Private Room Removed
141	Private Room Toggle
142	New Password
143	Private Room Add Operator
144	Private Room Remove Operator
145	Private Room Operator Added
146	Private Room Operator Removed
148	Private Room Owned
149	Message Users
150	Ask Public Chat	Deprecated
151	Stop Public Chat	Deprecated
152	Public Chat Message	Deprecated
153	Related Searches	Obsolete
1001	Can’t Connect To Peer
1003	Can’t Create Room

Server Code 1

Login

Function Names

Museekd: SLogin
Nicotine: Login

Description

Send your username, password, and client version.

Sending Login Example

Description	Message Length	Message Code	Username Length	Username	Password Length	Password
Human	72	1	8	username	8	password
Hex	48 00 00 00	01 00 00 00	08 00 00 00	75 73 65 72 6e 61 6d 65	08 00 00 00	70 61 73 73 77 6f 72 64

Message, continued

Description	Version	Length	Hash	Minor Version
Human	160	32	d51c9a7e9353746a6020f9602d452929	1
Hex	a0 00 00 00	20 00 00 00	64 35 31 63 39 61 37 65 39 33 35 33 37 34 36 61 36 30 32 30 66 39 36 30 32 64 34 35 32 39 32 39	01 00 00 00

Message as a Hex Stream 48 00 00 00 01 00 00 00 08 00 00 00 75 73 65 72 6e 61 6d 65 08 00 00 00 70 61 73 73 77 6f 72 64 a0 00 00 00 20 00 00 00 64 35 31 63 39 61 37 65 39 33 35 33 37 34 36 61 36 30 32 30 66 39 36 30 32 64 34 35 32 39 32 39 01 00 00 00

Data Order

• Send Login
  1. string username
  2. string password A non-empty string is required
  3. uint version number 178 for Museek+ 160 for Nicotine+
  4. string MD5 hex digest of concatenated username & password
  5. uint minor version Minor version (0x13000000 for 157 ns 13e, 0x11000000 for 157 ns 13c)

• Receive Login Success
  1. bool success 1
  2. string greet A MOTD string
  3. uint Your IP Address
  4. string MD5 hex digest of the password string Windows Soulseek uses this hash to determine if it’s connected to the official server

• Receive Login Failure
  1. bool failure 0
  2. string reason Almost always: Bad Password; sometimes it’s a banned message or another error.

Server Code 2

Set Listen Port

Function Names

Museekd: SSetListenPort
Nicotine: SetWaitPort

Description

We send this to the server to indicate the port number that we listen on (2234 by default).

If this value is set to zero, or the message is not sent upon login (which defaults the listen port to 0), remote clients handling a ConnectToPeer message (code 18) will fail to properly purge the request. Confirmed in Soulseek Qt 2020.3.12, but probably impacts most or all other versions.

Data Order

• Send
  1. uint port
  2. bool use obfuscation
  3. uint obfuscated port
• Receive
  • No Message

Server Code 3

Get Peer Address

Function Names

Museekd: SGetPeerAddress
Nicotine: GetPeerAddress

Description

We send this to the server to ask for a peer’s address (IP address and port), given the peer’s username.

Data Order

• Send
  1. string username
• Receive
  1. string username
  2. ip ip
  3. uint port
  4. bool use obfuscation
  5. uint obfuscated port

Server Code 5

Add User

Function Names

Museekd: SAddUser
Nicotine: AddUser

Description

Used to be kept updated about a user’s stats. When a user’s stats have changed, the server sends a GetUserStats response message with the new user stats.

Data Order

• Send
  1. string username
• Receive
  1. string username
  2. bool exists
  • If exists is true
    1. uint status 0 == Offline, 1 == Away; 2 == Online
    2. uint avgspeed
    3. uint64 uploadnum
    4. uint files
    5. uint dirs
    • If status is away/online
      1. string countrycode Uppercase country code

Server Code 6

Remove User

Function Names

Museekd: Unimplemented
Nicotine: RemoveUser

Description

Used when we no longer want to be kept updated about a user’s stats.

Data Order

• Send
  1. string username
• Receive
  • No Message

Server Code 7

Get Status

Function Names

Museekd: SGetStatus
Nicotine: GetUserStatus

Description

The server tells us if a user has gone away or has returned.

Data Order

• Send
  1. string username
• Receive
  1. string username
  2. uint status 0 == Offline, 1 == Away; 2 == Online
  3. bool privileged

Server Code 13

Say in Chat Room

Function Names

Museekd: SSayChatroom
Nicotine: SayChatroom

Description

Either we want to say something in the chatroom, or someone else did.

Data Order

• Send
  1. string room
  2. string message
• Receive
  1. string room
  2. string username
  3. string message

Server Code 14

Join a Room

Function Names

Museekd: SJoinRoom
Nicotine: JoinRoom

Description

We send this message to the server when we want to join a room. If the room doesn’t exist, it is created.

Server responds with this message when we join a room. Contains users list with data on everyone.

Data Order

• Send
  1. string room
  2. bool private If the room doesn’t exist, should the new room be private?

• Receive
  1. string room
  2. uint number of users in room For private rooms, also contain owner and operators
  3. Iterate the number of users museekd uses a vector of strings
     1. string username
  4. uint number of userdata
  5. Iterate the number of users museekd uses a vector of userdata
     1. uint status
  6. uint number of userdata
  7. Iterate the userdata vector of userdata (and add unpacked data to User Data)
     1. uint avgspeed
     2. uint64 uploadnum
     3. uint files
     4. uint dirs
  8. uint number of slotsfree
  9. Iterate thru number of slotsfree
     1. uint slotsfree
  10. uint number of usercountries
  11. Iterate thru number of usercountries
      1. string countrycode Uppercase country code
  12. string owner If private room
  13. uint number of operators in room If private room
  14. Iterate the number of operators museekd uses a vector of strings
      1. string operator

Server Code 15

Leave Room

Function Names

Museekd: SLeaveRoom
Nicotine: LeaveRoom

Description

We send this to the server when we want to leave a room.

Data Order

• Send
  1. string room
• Receive
  1. string room

Server Code 16

A User Joined a Room

Function Names

Museekd: SUserJoinedRoom
Nicotine: UserJoinedRoom

Description

The server tells us someone has just joined a room we’re in.

Data Order

• Send
  • No Message
• Receive
  1. string room
  2. string username
  3. uint status
  4. uint avgspeed
  5. uint64 uploadnum
  6. uint files
  7. uint dirs
  8. uint slotsfree
  9. string countrycode Uppercase country code

Server Code 17

A User Left a Room

Function Names

Museekd: SUserLeftRoom
Nicotine: UserLeftRoom

Description

The server tells us someone has just left a room we’re in.

Data Order

• Send
  • No Message
• Receive
  1. string room
  2. string username

Server Code 18

Connect To Peer

Function Names

Museekd: SConnectToPeer
Nicotine: ConnectToPeer

Description

Either we ask server to tell someone else we want to establish a connection with them, or server tells us someone wants to connect with us. Used when the side that wants a connection can’t establish it, and tries to go the other way around (direct connection has failed).

See also: Peer Connection Message Order

Data Order

• Send
  1. uint token
  2. string username
  3. string type Connection Type (P, F or D)
• Receive
  1. string username
  2. string type Connection Type (P, F or D)
  3. ip ip
  4. uint port
  5. uint token Use this token for Pierce Firewall
  6. bool privileged
  7. bool use obfuscation
  8. uint obfuscated port

Server Code 22

Private Messages

Function Names

Museekd: SPrivateMessage
Nicotine: MessageUser

Description

Chat phrase sent to someone or received by us in private.

Data Order

• Send
  1. string username
  2. string message
• Receive
  1. uint ID
  2. uint timestamp
  3. string username
  4. string message
  5. bool new message 1 if message is new, 0 if message is re-sent (e.g. if recipient was offline)

Server Code 23

Acknowledge Private Message

Function Names

Museekd: SAckPrivateMessage
Nicotine: MessageAcked

Description

We send this to the server to confirm that we received a private message. If we don’t send it, the server will keep sending the chat phrase to us.

Museekd also resets timestamps to account for server-time bugginess.

Data Order

• Send
  1. uint message ID
• Receive
  • No Message

Server Code 26

File Search

Function Names

Museekd: SFileSearch
Nicotine: FileSearch

Description

We send this to the server when we search for something. Alternatively, the server sends this message outside the distributed network to tell us that someone is searching for something, currently used for UserSearch and RoomSearch requests.

The ticket/search id is a random number generated by the client and is used to track the search results.

Data Order

• Send
  1. uint ticket
  2. string search query
• Receive search request from another user
  1. string username
  2. uint ticket
  3. string search query

Server Code 28

Set Online Status

Function Names

Museekd: SSetStatus
Nicotine: SetStatus

Description

We send our new status to the server. Status is a way to define whether you’re available or busy.

1 = Away
2 = Online

Data Order

• Send
  1. int status
• Receive
  • No Message

Server Code 32

Ping

Function Names

Museekd: SPing
Nicotine: ServerPing

Description

DEPRECATED

We test if the server responds.

Data Order

• Send
  • Empty Message
• Receive
  • Empty Message

Server Code 33

Send Connect Token

Function Names

Museekd: Unimplemented
Nicotine: SendConnectToken

Description

OBSOLETE, no longer used

Data Order

• Send
  1. string username
  2. uint token
• Receive
  1. string username
  2. uint token

Server Code 34

Send Download Speed

Function Names

Museekd: SSendSpeed
Nicotine: SendDownloadSpeed

Description

OBSOLETE, use SendUploadSpeed server message

We used to send this after a finished download to let the server update the speed statistics for a user.

Data Order

• Send average transfer speed
  1. string username
  2. uint speed
• Receive
  • No Message

Server Code 35

Shared Folders & Files

Function Names

Museekd: SSharedFoldersFiles
Nicotine: SharedFoldersFiles

Description

We send this to server to indicate the number of folder and files that we share.

Data Order

• Send
  1. uint dirs
  2. uint files
• Receive
  • No Message

Server Code 36

Get User Stats

Function Names

Museekd: SGetUserStats
Nicotine: GetUserStats

Description

The server sends this to indicate a change in a user’s statistics, if we’ve requested to watch the user in AddUser previously. A user’s stats can also be requested by sending a GetUserStats message to the server, but AddUser should be used instead.

Data Order

• Send
  1. string username
• Receive
  1. string username
  2. uint avgspeed
  3. uint64 uploadnum
  4. uint files
  5. uint dirs

Server Code 40

Queued Downloads

Function Names

Museekd: Unimplemented
Nicotine: QueuedDownloads

Description

OBSOLETE, no longer sent by the server

The server sends this to indicate if someone has download slots available or not.

Data Order

• Send
  • No Message
• Receive
  1. string username
  2. bool slotsfree Can immediately download

Server Code 41

Kicked from Server

Function Names

Museekd: SKicked
Nicotine: Relogged

Description

The server sends this if someone else logged in under our nickname, and then disconnects us.

Data Order

• Send
  • No Message
• Receive
  • Empty Message

Server Code 42

User Search

Function Names

Museekd: SUserSearch
Nicotine: UserSearch

Description

We send this to the server when we search a specific user’s shares. The ticket/search id is a random number generated by the client and is used to track the search results.

Data Order

• Send
  1. string username
  2. uint ticket
  3. string search query
• Receive
  • No Message

Server Code 51

Add Liked Interest

Function Names

Museekd: SInterestAdd
Nicotine: AddThingILike

Description

DEPRECATED, used in Soulseek NS but not SoulseekQt

We send this to the server when we add an item to our likes list.

Data Order

• Send
  1. string item
• Receive
  • No Message

Server Code 52

Remove Liked Interest

Function Names

Museekd: SInterestRemove
Nicotine: RemoveThingILike

Description

DEPRECATED, used in Soulseek NS but not SoulseekQt

We send this to the server when we remove an item from our likes list.

Data Order

• Send
  1. string item
• Receive
  • No Message

Server Code 54

Get Recommendations

Function Names

Museekd: SGetRecommendations
Nicotine: Recommendations

Description

DEPRECATED, used in Soulseek NS but not SoulseekQt

The server sends us a list of personal recommendations and a number for each.

Data Order

• Send
  • Empty Message
• Receive
  1. uint number of total recommendations
  2. Iterate for number of total recommendations
     1. string recommendation
     2. int number of recommendations this recommendation has
  3. uint number of total unrecommendations
  4. Iterate for number of total unrecommendations
     1. string unrecommendation
     2. int number of unrecommendations this unrecommendation has (negative)

Server Code 56

Get Global Recommendations

Function Names

Museekd: SGetGlobalRecommendations
Nicotine: GlobalRecommendations

Description

DEPRECATED, used in Soulseek NS but not SoulseekQt

The server sends us a list of global recommendations and a number for each.

Data Order

• Send
  • Empty Message
• Receive
  1. uint number of total recommendations
  2. Iterate for number of total recommendations
     1. string recommendation
     2. int number of recommendations this recommendation has
  3. uint number of total unrecommendations
  4. Iterate for number of total unrecommendations
     1. string unrecommendation
     2. int number of unrecommendations this unrecommendation has (negative)

Server Code 57

Get User Interests

Function Names

Museekd: SUserInterests
Nicotine: UserInterests

Description

DEPRECATED, used in Soulseek NS but not SoulseekQt

We ask the server for a user’s liked and hated interests. The server responds with a list of interests.

Data Order

• Send
  1. string username
• Receive
  1. string username
  2. uint number of liked interests
  3. Iterate for number of liked interests
     1. string interest
  4. uint number of hated interests
  5. Iterate for number of hated interests
     1. string interest

Server Code 58

Admin Command

Function Names

Museekd: Unimplemented
Nicotine: AdminCommand

Description

OBSOLETE, no longer used since Soulseek stopped supporting third-party servers in 2002

We send this to the server to run an admin command (e.g. to ban or silence a user) if we have admin status on the server.

Data Order

• Send
  1. string command
  2. uint number of command arguments
  3. Iterate for number of command arguments
     1. string command argument
• Receive
  • No Message

Server Code 60

Place In Line Response

Description

OBSOLETE, use PlaceInQueue peer message

The server sends this to indicate change in place in queue while we’re waiting for files from another peer.

Function Names

Museekd: Unimplemented
Nicotine: PlaceInLineResponse

Data Order

• Send
  1. string username
  2. uint req
  3. uint place
• Receive
  1. string username
  2. uint req
  3. uint place

Server Code 62

Room Added

Description

OBSOLETE, no longer sent by the server

The server tells us a new room has been added.

Function Names

Museekd: Unimplemented
Nicotine: RoomAdded

Data Order

• Send
  • No Message
• Receive
  1. string room

Server Code 63

Room Removed

Description

OBSOLETE, no longer sent by the server

The server tells us a room has been removed.

Function Names

Museekd: Unimplemented
Nicotine: RoomRemoved

Data Order

• Send
  • No Message
• Receive
  1. string room

Server Code 64

Room List

Function Names

Museekd: SRoomList
Nicotine: RoomList

Description

The server tells us a list of rooms and the number of users in them. When connecting to the server, the server only sends us rooms with at least 5 users. A few select rooms are also excluded, such as nicotine and The Lobby. Requesting the room list yields a response containing the missing rooms.

Data Order

• Send
  • Empty Message
• Receive
  1. uint number of rooms
  2. Iterate for number of rooms
     1. string room
  3. uint number of rooms
  4. Iterate for number of rooms
     1. uint number of users in room

1. uint number of owned private rooms
2. Iterate for number of owned private rooms
   1. string owned private room
3. uint number of owned private rooms
4. Iterate for number of owned private rooms
   1. uint number of users in owned private room

1. uint number of private rooms (except owned)
2. Iterate for number of private rooms (except owned)
   1. string private room
3. uint number of private rooms (except owned)
4. Iterate for number of private rooms (except owned)
   1. uint number of users in private rooms (except owned)

1. uint number of operated private rooms
2. Iterate for number of operated private rooms
   1. string operated private room

Server Code 65

Exact File Search

Function Names

Museekd: SExactFileSearch
Nicotine: ExactFileSearch

Description

OBSOLETE, no results even with official client

We send this to search for an exact file name and folder, to find other sources.

Data Order

• Send
  1. uint token
  2. string filename
  3. string path
  4. uint64 filesize
  5. uint checksum
• Receive
  1. string username
  2. uint token
  3. string filename
  4. string path
  5. uint64 filesize
  6. uint checksum

Server Code 66

Global / Admin Message

Function Names

Museekd: SGlobalMessage
Nicotine: AdminMessage

Description

A global message from the server admin has arrived.

Data Order

• Send
  • No Message
• Receive
  1. string message

Server Code 67

Global User List

Function Names

Museekd: Unimplemented
Nicotine: GlobalUserList

Description

OBSOLETE, no longer used

We send this to get a global list of all users online.

Data Order

• Send
  • Empty Message
• Receive
  1. uint number of users in room
  2. Iterate the number of users
     1. string username
  3. uint number of userdata
  4. Iterate the number of users
     1. uint status
  5. uint number of userdata
  6. Iterate the userdata
     1. uint avgspeed
     2. uint64 uploadnum
     3. uint files
     4. uint dirs
  7. uint number of slotsfree
  8. Iterate thru number of slotsfree
     1. uint slotsfree
  9. uint number of usercountries
  10. Iterate thru number of usercountries
      1. string countrycode Uppercase country code

Server Code 68

Tunneled Message

Function Names

Museekd: Unimplemented
Nicotine: TunneledMessage

Description

OBSOLETE, no longer used

Server message for tunneling a chat message.

Data Order

• Send
  1. string username
  2. uint token
  3. uint code
  4. string message
• Receive
  1. string username
  2. uint code
  3. uint token
  4. ip ip
  5. uint port
  6. string message

Server Code 69

Privileged Users

Function Names

Museekd: SPrivilegedUsers
Nicotine: PrivilegedUsers

Description

The server sends us a list of privileged users, a.k.a. users who have donated.

Data Order

• Send
  • No Message
• Receive
  1. uint number of users
  2. Iterate number of users
     1. string username

Server Code 71

Have No Parents

Function Names

Museekd: SHaveNoParents
Nicotine: HaveNoParent

Description

We inform the server if we have a distributed parent or not. If not, the server eventually sends us a PossibleParents message with a list of possible parents to connect to. If no candidates are found, no such message is sent by the server, and we eventually become a branch root.

Data Order

• Send
  1. bool have parents
• Receive
  • No Message

Server Code 73

Parent’s IP

Function Names

Museekd: SParentIP
Nicotine: SearchParent

Description

DEPRECATED, sent by Soulseek NS but not SoulseekQt

We send the IP address of our parent to the server.

Data Order

• Send
  1. ip ip
• Receive
  • No Message

Server Code 83

Parent Min Speed

Description

The server informs us about the minimum upload speed required to become a parent in the distributed network.

Function Names

Museekd: SParentMinSpeed
Nicotine: ParentMinSpeed

Data Order

• Send
  • No Message
• Receive
  1. uint speed

Server Code 84

Parent Speed Ratio

Description

The server sends us a speed ratio determining the number of children we can have in the distributed network. The maximum number of children is our upload speed divided by the speed ratio.

Function Names

Museekd: SParentSpeedRatio
Nicotine: ParentSpeedRatio

Data Order

• Send
  • No Message
• Receive
  1. uint ratio

Server Code 86

Parent Inactivity Timeout

Description

OBSOLETE, no longer sent by the server

Function Names

Museekd: SParentInactivityTimeout
Nicotine: ParentInactivityTimeout

Data Order

• Send
  • No Message
• Receive
  1. uint number

Server Code 87

Search Inactivity Timeout

Description

OBSOLETE, no longer sent by the server

Function Names

Museekd: SSearchInactivityTimeout
Nicotine: SearchInactivityTimeout

Data Order

• Send
  • No Message
• Receive
  1. uint number

Server Code 88

Minimum Parents In Cache

Description

OBSOLETE, no longer sent by the server

Function Names

Museekd: SMinParentsInCache
Nicotine: MinParentsInCache

Description

Data Order

• Send
  • No Message
• Receive
  1. uint number

Server Code 90

Distributed Alive Interval

Description

OBSOLETE, no longer sent by the server

Function Names

Museekd: SDistribAliveInterval
Nicotine: DistribAliveInterval

Description

Data Order

• Send
  • No Message
• Receive
  1. uint number

Server Code 91

Add Privileged User

Function Names

Museekd: SAddPrivileged
Nicotine: AddToPrivileged

Description

OBSOLETE, no longer sent by the server

The server sends us the username of a new privileged user, which we add to our list of global privileged users.

Data Order

• Send
  • No Message
• Receive
  1. string username

Server Code 92

Check Privileges

Function Names

Museekd: SCheckPrivileges
Nicotine: CheckPrivileges

Description

We ask the server how much time we have left of our privileges. The server responds with the remaining time, in seconds.

Data Order

• Send
  • Empty Message
• Receive
  1. uint time left

Server Code 93

Embedded Message

Description

The server sends us an embedded distributed message. The only type of distributed message sent at present is DistribSearch (distributed code 3). If we receive such a message, we are a branch root in the distributed network, and we distribute the embedded message (not the unpacked distributed message) to our child peers.

Function Names

Museekd: SSearchRequest
Nicotine: EmbeddedMessage

Data Order

• Send
  • No Message
• Receive
  1. uchar distributed code
  2. bytes distributed message Raw message associated with distributed code

Server Code 100

Accept Children

Description

We tell the server if we want to accept child nodes.

Function Names

Museekd: SAcceptChildren
Nicotine: AcceptChildren (not yet used)

Data Order

• Send
  1. bool accept
• Receive
  • No Message

Server Code 102

Possible Parents

Description

The server send us a list of max 10 possible distributed parents to connect to. Messages of this type are sent to us at regular intervals, until we tell the server we don’t need more possible parents with a HaveNoParent message.

The received list always contains users whose upload speed is higher than our own. If we have the highest upload speed on the server, we become a branch root, and start receiving SearchRequest messages directly from the server.

Function Names

Museekd: SNetInfo
Nicotine: PossibleParents

Data Order

• Send
  • No Message
• Receive list of search parents
  1. uint number of parents
  2. Iterate for number of parents
     1. string username
     2. ip ip
     3. uint port

Server Code 103

Wishlist Search

Function Names

Museekd: SWishlistSearch
Nicotine: WishlistSearch

Description

Data Order

• Send
  1. uint ticket
  2. string search query
• Receive
  • No Message

Server Code 104

Wishlist Interval

Function Names

Museekd: SWishlistInterval
Nicotine: WishlistInterval

Description

Data Order

• Send
  • No Message
• Receive
  1. uint interval

Server Code 110

Get Similar Users

Function Names

Museekd: SGetSimilarUsers
Nicotine: SimilarUsers

Description

DEPRECATED, used in Soulseek NS but not SoulseekQt

The server sends us a list of similar users related to our interests.

Data Order

• Send
  • Empty Message
• Receive
  1. uint number of users
  2. Iterate for number of user
     1. string username
     2. uint status

Server Code 111

Get Item Recommendations

Function Names

Museekd: SGetItemRecommendations
Nicotine: ItemRecommendations

Description

DEPRECATED, used in Soulseek NS but not SoulseekQt

The server sends us a list of recommendations related to a specific item, which is usually present in the like/dislike list or an existing recommendation list.

Data Order

• Send
  1. string item
• Receive
  1. string item
  2. uint number of recommendations
  3. Iterate for number of recommendations
     1. string recommendation
     2. uint number of recommendations for this recommendation (can be negative)

Server Code 112

Get Item Similar Users

Function Names

Museekd: SGetItemSimilarUsers
Nicotine: ItemSimilarUsers

Description

DEPRECATED, used in Soulseek NS but not SoulseekQt

The server sends us a list of similar users related to a specific item, which is usually present in the like/dislike list or recommendation list.

Data Order

• Send
  1. string item
• Receive
  1. string item
  2. uint number of users
  3. Iterate for number of user
     1. string username

Server Code 113

Room Tickers

Function Names

Museekd: SRoomTickers
Nicotine: RoomTickerState

Description

The server returns a list of tickers in a chat room.

Tickers are customizable, user-specific messages that appear on chat room walls.

Data Order

• Send
  • No Message
• Receive
  1. string room
  2. uint number of users
  3. Iterate for number of user
     1. string username
     2. string tickers

Server Code 114

Room Ticker Add

Function Names

Museekd: SRoomTickerAdd
Nicotine: RoomTickerAdd

Description

The server sends us a new ticker that was added to a chat room.

Tickers are customizable, user-specific messages that appear on chat room walls.

Data Order

• Send
  • No Message
• Receive
  1. string room
  2. string username
  3. string ticker

Server Code 115

Room Ticker Remove

Function Names

Museekd: SRoomTickerRemove
Nicotine: RoomTickerRemove

Description

The server informs us that a ticker was removed from a chat room.

Tickers are customizable, user-specific messages that appear on chat room walls.

Data Order

• Send
  • No Message
• Receive
  1. string room
  2. string username

Server Code 116

Set Room Ticker

Function Names

Museekd: SSetRoomTicker
Nicotine: RoomTickerSet

Description

We send this to the server when we change our own ticker in a chat room. Sending an empty ticker string removes any existing ticker in the room.

Tickers are customizable, user-specific messages that appear on chat room walls.

Data Order

• Send
  1. string room
  2. string ticker
• Receive
  • No Message

Server Code 117

Add Hated Interest

Function Names

Museekd: SInterestHatedAdd
Nicotine: AddThingIHate

Description

DEPRECATED, used in Soulseek NS but not SoulseekQt

We send this to the server when we add an item to our hate list.

Data Order

• Send
  1. string item
• Receive
  • No Message

Server Code 118

Remove Hated Interest

Function Names

Museekd: SInterestHatedRemove
Nicotine: RemoveThingIHate

Description

DEPRECATED, used in Soulseek NS but not SoulseekQt

We send this to the server when we remove an item from our hate list.

Data Order

• Send
  1. string item
• Receive
  • No Message

Server Code 120

Room Search

Function Names

Museekd: SRoomSearch
Nicotine: RoomSearch

Description

We send this to the server to search files shared by users who have joined a specific chat room. The ticket/search id is a random number generated by the client and is used to track the search results.

Data Order

• Send
  1. string room
  2. uint ticket
  3. string search query
• Receive
  • No Message

Server Code 121

Send Upload Speed

Function Names

Museekd: SSendUploadSpeed
Nicotine: SendUploadSpeed

Description

We send this after a finished upload to let the server update the speed statistics for ourselves.

Data Order

• Send average upload transfer speed
  1. uint speed
• Receive
  • No Message

Server Code 122

User Privileges

Function Names

Museekd: SUserPrivileges
Nicotine: UserPrivileged

Description

DEPRECATED, use AddUser and GetUserStatus server messages

We ask the server whether a user is privileged or not.

Data Order

• Send
  1. string username
• Receive
  1. string username
  2. bool privileged

Server Code 123

Give Privileges

Function Names

Museekd: SGivePrivileges
Nicotine: GivePrivileges

Description

We give (part of) our privileges, specified in days, to another user on the network.

Data Order

• Send
  1. string username
  2. uint days
• Receive
  • No Message

Server Code 124

Notify Privileges

Function Names

Museekd: SNotifyPrivileges
Nicotine: NotifyPrivileges

Description

DEPRECATED, no longer used

Data Order

• Send
  1. uint token
  2. string username
• Receive
  1. uint token
  2. string username

Server Code 125

Acknowledge Privilege Notification

Function Names

Museekd: SAckNotifyPrivileges
Nicotine: AckNotifyPrivileges

Description

DEPRECATED, no longer used

Data Order

• Send
  1. uint token
• Receive
  1. uint token

Server Code 126

Branch Level

Description

We tell the server what our position is in our branch (xth generation) on the distributed network.

Function Names

Museekd: SBranchLevel
Nicotine: BranchLevel

Data Order

• Send
  1. uint branch level
• Receive
  • No Message

Server Code 127

Branch Root

Description

We tell the server the username of the root of the branch we’re in on the distributed network.

Function Names

Museekd: SBranchRoot
Nicotine: BranchRoot

Data Order

• Send
  1. string branch root
• Receive
  • No Message

Server Code 129

Child Depth

Description

We tell the server the maximum number of generation of children we have on the distributed network.

Function Names

Museekd: SChildDepth
Nicotine: ChildDepth

Data Order

• Send
  1. uint child depth
• Receive
  • No Message

Server Code 130

Reset Distributed

Function Names

Museekd: Unimplemented
Nicotine: ResetDistributed

Description

The server asks us to reset our distributed parent and children.

Data Order

• Send
  • No Message
• Receive
  • Empty Message

Server Code 133

Private Room Users

Description

The server sends us a list of room users that we can alter (add operator abilities / dismember).

Function Names

Museekd: SPrivRoomAlterableMembers
Nicotine: PrivateRoomUsers

Data Order

• Send
  1. No Message
• Receive
  1. string room
  2. uint number of users
  3. Iterate for number of users
     1. string users

Server Code 134

Private Room Add User

Description

We send this to inform the server that we’ve added a user to a private room.

Function Names

Museekd: SPrivRoomAddUser
Nicotine: PrivateRoomAddUser

Data Order

• Send
  1. string room
  2. string username
• Receive
  1. string room
  2. string username

Server Code 135

Private Room Remove User

Description

We send this to inform the server that we’ve removed a user from a private room.

Function Names

Museekd: SPrivRoomRemoveUser
Nicotine: PrivateRoomRemoveUser

Data Order

• Send
  1. string room
  2. string username
• Receive
  1. string room
  2. string username

Server Code 136

Private Room Drop Membership

Description

We send this to the server to remove our own membership of a private room.

Function Names

Museekd: SPrivRoomDismember
Nicotine: PrivateRoomDismember

Data Order

• Send
  1. string room
• Receive
  • No Message

Server Code 137

Private Room Drop Ownership

Description

We send this to the server to stop owning a private room.

Function Names

Museekd: SPrivRoomDisown
Nicotine: PrivateRoomDisown

Data Order

• Send
  1. string room
• Receive
  • No Message

Server Code 138

Private Room Unknown

Description

OBSOLETE, no longer used

Unknown purporse

Function Names

Museekd: SPrivRoomUnknown138
Nicotine: PrivateRoomSomething

Data Order

• Send
  1. string room
• Receive
  1. string room

Server Code 139

Private Room Added

Description

The server sends us this message when we are added to a private room.

Function Names

Museekd: SPrivRoomAdded
Nicotine: PrivateRoomAdded

Data Order

• Send
  • No Message
• Receive
  1. string room

Server Code 140

Private Room Removed

Description

The server sends us this message when we are removed from a private room.

Function Names

Museekd: SPrivRoomRemoved
Nicotine: PrivateRoomRemoved

Data Order

• Send
  • No Message
• Receive
  1. string room

Server Code 141

Private Room Toggle

Description

We send this when we want to enable or disable invitations to private rooms.

Function Names

Museekd: SPrivRoomToggle
Nicotine: PrivateRoomToggle

Data Order

• Send
  1. bool enable
• Receive
  1. bool enable

Server Code 142

New Password

Description

We send this to the server to change our password. We receive a response if our password changes.

Function Names

Museekd: SNewPassword
Nicotine: ChangePassword

Data Order

• Send
  1. string pass
• Receive
  1. string pass

Server Code 143

Private Room Add Operator

Description

We send this to the server to add private room operator abilities to a user.

Function Names

Museekd: SPrivRoomAddOperator
Nicotine: PrivateRoomAddOperator

Data Order

• Send
  1. string room
  2. string username
• Receive
  1. string room
  2. string username

Server Code 144

Private Room Remove Operator

Description

We send this to the server to remove private room operator abilities from a user.

Function Names

Museekd: SPrivRoomRemoveOperator
Nicotine: PrivateRoomRemoveOperator

Data Order

• Send
  1. string room
  2. string username
• Receive
  1. string room
  2. string username

Server Code 145

Private Room Operator Added

Description

The server send us this message when we’re given operator abilities in a private room.

Function Names

Museekd: SPrivRoomOperatorAdded
Nicotine: PrivateRoomOperatorAdded

Data Order

• Send
  • No Message
• Receive
  1. string room

Server Code 146

Private Room Operator Removed

Description

The server send us this message when our operator abilities are removed in a private room.

Function Names

Museekd: SPrivRoomOperatorRemoved
Nicotine: PrivateRoomOperatorRemoved

Data Order

• Send
  • No Message
• Receive
  1. string room

Server Code 148

Private Room Operators

Description

The server sends us a list of operators in a specific room, that we can remove operator abilities from.

Function Names

Museekd: SPrivRoomAlterableOperators
Nicotine: PrivateRoomOwned

Data Order

• Send
  • No Message
• Receive
  1. string room
  2. uint number of operators in room
  3. Iterate the number of operators museekd uses a vector of strings
     1. string operator

Server Code 149

Message Users

Description

Sends a broadcast private message to the given list of users.

Function Names

Museekd: SMessageUsers
Nicotine: MessageUsers

Data Order

• Send
  1. uint number of users
  2. Iterate the number of users museekd uses a vector of strings
     1. string username
  3. string message
• Receive
  • No Message

Server Code 150

Ask Public Chat

Description

DEPRECATED, used in Soulseek NS but not SoulseekQt

We ask the server to send us messages from all public rooms, also known as public chat.

Function Names

Museekd: SAskPublicChat
Nicotine: JoinPublicRoom

Data Order

• Send
  • Empty Message
• Receive
  • No Message

Server Code 151

Stop Public Chat

Description

DEPRECATED, used in Soulseek NS but not SoulseekQt

We ask the server to stop sending us messages from all public rooms, also known as public chat.

Function Names

Museekd: SStopPublicChat
Nicotine: LeavePublicRoom

Data Order

• Send
  • Empty Message
• Receive
  • No Message

Server Code 152

Public Chat Message

Description

DEPRECATED, used in Soulseek NS but not SoulseekQt

The server sends this when a new message has been written in a public room (every single line written in every public room).

Function Names

Museekd: SPublicChat
Nicotine: PublicRoomMessage

Data Order

• Send
  • No Message
• Receive
  1. string room
  2. string username
  3. string message

Server Code 153

Related Searches

Description

OBSOLETE, server sends empty list as of 2018

The server returns a list of related search terms for a search query.

Function Names

Museekd: SRelatedSearch
Nicotine: RelatedSearch

Data Order

• Send
  1. string query
• Receive
  1. string query
  2. uint number of terms
  3. Iterate for number of term
     1. string term
     2. uint score

Server Code 1001

Can’t Connect To Peer

Function Names

Museekd: SCannotConnect
Nicotine: CantConnectToPeer

Description

We send this to say we can’t connect to peer after it has asked us to connect. We receive this if we asked peer to connect and it can’t do this. This message means a connection can’t be established either way.

See also: Peer Connection Message Order

Data Order

• Send to the Server if we cannot connect to a peer.
  1. uint token
  2. string username
• Receive this response means we are both firewalled or otherwise unable to connect to each other.
  1. uint token
  2. string username

Server Code 1003

Can’t Create Room

Function Names

Museekd: Unimplemented
Nicotine: CantCreateRoom

Description

Server tells us a new room cannot be created. This message only seems to be sent if you try to create a room with the same name as an existing private room. In other cases, such as using a room name with leading or trailing spaces, only a private message containing an error message is sent.

Data Order

• Send
  • No Message
• Receive
  1. string room

Peer Init Messages

Send	Receive
Send to Peer	Receive from Peer

In museekd 0.1.13, these messages are sent and received in Museek/BaseConnection.cc and defined in Museek/InitMessages.hh. Since museekd 0.2, they are defined in museekd/handshakemessages.h.

In Nicotine, these messages are matched to their message number in slskproto.py in the SlskProtoThread function, defined in slskmessages.py and callbacks for the messages are set in pynicotine.py.

Message Format

Message Length	Code	Message Contents
4 Bytes	1 Byte	…

Message Index

Code	Message
0	Pierce Firewall
1	Peer Init

Peer Connection Message Order

1. User A sends a Peer Init to User B.
   If this succeeds, a connection is established, and User A is free to send peer messages.
   If this fails (socket cannot connect), User A proceeds with an indirect connection request (step 2).
2. User A sends ConnectToPeer to the Server with a unique token
3. The Server sends a ConnectToPeer response to User B with the same token
4. User B sends a Pierce Firewall to User A with the same token.
   If this succeeds, a connection is established, and User A is free to send peer messages.
   If this fails, User B retries for ~1 minute. If this still fails, no connection is possible, and User B proceeds with step 5.
5. User B sends a Cannot Connect to the Server.
6. The Server sends a Cannot Connect response to User A.

Peer Init Code 0

Pierce Firewall

Function Names

Museekd: HPierceFirewall
Nicotine: PierceFireWall

Description

This is the very first message sent by the peer that established a connection, if it has been asked by the other peer to do so. The token is taken from the ConnectToPeer server message.

See also: Peer Connection Message Order

Data Order

• Send
  • uint token Unique Number
• Receive
  • uint token Unique Number

Peer Init Code 1

Peer Init

Function Names

Museekd: HInitiate
Nicotine: PeerInit

Description

This message is sent by the peer that initiated a connection, not necessarily a peer that actually established it. Token apparently can be anything. Type is ‘P’ if it’s anything but filetransfer, ‘F’ otherwise.

See also: Peer Connection Message Order

Data Order

• Send
  • string username Local Username
  • string type Connection Type (P, F or D)
  • uint token Unique Number
• Receive
  • string username Remote Username
  • string type Connection Type (P, F or D)
  • uint token Unique Number

Peer Messages

Send	Receive
Send to Peer	Receive from Peer

In museekd 0.1.13, these messages are sent and received in Museek/PeerConnection.cc and defined in Museek/PeerMessages.hh. Since museekd 0.2, they are defined in museekd/peermessages.h.

In Nicotine, these messages are matched to their message number in slskproto.py in the SlskProtoThread function, defined in slskmessages.py and callbacks for the messages are set in pynicotine.py.

Message Format

Message Length	Code	Message Contents
4 Bytes	4 Bytes	…

Message Index

Code	Message	Status
4	Shares Request
5	Shares Reply
8	Search Request	Obsolete
9	Search Reply
15	User Info Request
16	User Info Reply
36	Folder Contents Request
37	Folder Contents Reply
40	Transfer Request
41	Upload Reply
41	Download Reply	Deprecated
41	Transfer Reply
42	Upload Placehold	Obsolete
43	Queue Upload
44	Place In Queue Reply
46	Upload Failed
50	Upload Denied
51	Place In Queue Request
52	Upload Queue Notification	Deprecated

Peer Code 4

Shares Request

Function Names

Museekd: PSharesRequest
Nicotine: GetShareFileList

Description

We send this to a peer to ask for a list of shared files.

Data Order

• Send
  • Empty Message
• Receive
  • Empty Message

Peer Code 5

Shares Reply

Function Names

Museekd: PSharesReply
Nicotine: SharedFileList

Description

A peer responds with a list of shared files when we’ve sent a GetSharedFileList.

Data Order

• Send shares database
  1. Iterate thru shares database
     1. data
• Receive shares database
  1. decompress
  2. uint number of directories
  3. Iterate number of directories
     1. string directory
     2. uint number of files
     3. Iterate number of files
        1. uchar ??? (unused)
        2. string filename
        3. unit64 size File size
        4. string ext Extentsion
        5. uint number of attributes
        6. Iterate number of attributes
           1. uint place in attributes (unused by museekd)
           2. uint attribute
  4. uint unknown official clients always send a value of 0
  5. uint number of private directories
  6. Iterate number of private directories
     1. string directory
     2. uint number of files
     3. Iterate number of files
        1. uchar ??? (unused)
        2. string filename
        3. uint64 size File size
        4. string ext Extentsion
        5. uint number of attributes
        6. Iterate number of attributes
           1. uint place in attributes (unused by museekd)
           2. uint attribute

Peer Code 8

Search Request

Function Names

Museekd: PSearchRequest
Nicotine: FileSearchRequest

Description

OBSOLETE, use UserSearch server message

We send this to the peer when we search for a file. Alternatively, the peer sends this to tell us it is searching for a file.

Data Order

• Send
  1. uint ticket
  2. string query
• Receive
  1. uint ticket
  2. string query

Peer Code 9

Search Reply

Function Names

Museekd: PSearchReply
Nicotine: FileSearchResult

Description

A peer sends this message when it has a file search match. The token/ticket is taken from original FileSearch, UserSearch or RoomSearch message.

Data Order

• Send
  1. string username
  2. uint ticket
  3. uint results size number of results
  4. Iterate for number of results
     1. uchar 1
     2. string filename
     3. uint64 size
     4. string ext
     5. uint attribute size
     6. Iterate number of attributes
        1. uint place in attributes
        2. uint attribute
  5. bool slotfree
  6. uint avgspeed
  7. uint64 queue length
  8. uint private results size number of privately shared results
  9. Iterate for number of privately shared results
     1. uchar 1
     2. string filename
     3. uint64 size
     4. string ext
     5. uint attribute size
     6. Iterate number of attributes
        1. uint place in attributes
        2. uint attribute
• Receive
  1. decompress
  2. string username
  3. uint ticket
  4. uint results size number of results
  5. Iterate for number of results
     1. string filename
     2. uint64 size
     3. string ext
     4. uint number of attributes
     5. Iterate number of attributes
        1. uint place in attributes
        2. uint attribute
  6. bool slotfree
  7. uint avgspeed
  8. uint64 queue length
  9. uint private results size number of privately shared results
  10. Iterate for number of privately shared results
      1. string filename
      2. uint64 size
      3. string ext
      4. uint number of attributes
      5. Iterate number of attributes
         1. uint place in attributes
         2. uint attribute

Peer Code 15

User Info Request

Function Names

Museekd: PInfoRequest
Nicotine: UserInfoRequest

Description

We ask the other peer to send us their user information, picture and all.

Data Order

• Send
  • Empty Message
• Receive
  • Empty Message

Peer Code 16

User Info Reply

Function Names

Museekd: PInfoReply
Nicotine: UserInfoReply

Description

A peer responds with this when we’ve sent a UserInfoRequest.

Data Order

• Send
  1. string description
  2. Check contents of picture
     • If picture is not empty
       1. bool has picture 1
       2. string picture
     • If picture is empty
       1. bool has picture 0
  3. uint totalupl
  4. uint queuesize
  5. bool slotsfree Can immediately upload
  6. uint uploadpermitted Who can upload anything to us? 0 == No one; 1 == Everyone; 2 == Users in List; 3 == Trusted Users
• Receive
  1. string description
  2. bool has picture
  3. Check contents of has picture
     1. If has picture is not empty
        1. string picture
  4. uint totalupl
  5. uint queuesize
  6. bool slotsfree Can immediately download
  7. uint uploadpermitted Who can upload anything to this user (not sent by SoulseekQt)? 0 == No one; 1 == Everyone; 2 == Users in List; 3 == Trusted Users

Peer Code 36

Folder Contents Request

Function Names

Museekd: PFolderContentsRequest
Nicotine: FolderContentsRequest

Description

We ask the peer to send us the contents of a single folder.

Data Order

• Send
  1. uint number of files in directory
  2. Iterate number of files in directory
     1. string file
• Receive
  1. uint number of files in directory
  2. Iterate number of files in directory
     1. string file

Peer Code 37

Folder Contents Reply

Function Names

Museekd: PFolderContentsReply
Nicotine: FolderContentsResponse

Description

A peer responds with the contents of a particular folder (with all subfolders) when we’ve sent a FolderContentsRequest.

Data Order

• Send
  1. uint number of folders
  2. Iterate for number of folders
     1. string dir
     2. uint number of files
     3. Iterate number of files
        1. uchar 1
        2. string file
        3. uint64 size
        4. string ext Extension
        5. uint number of attributes
           1. uint attribute number
           2. uint attribute
• Receive
  1. decompress
  2. uint number of folders
  3. Iterate for number of folders
     1. string dir
     2. uint number of files
     3. Iterate number of files
        1. uchar ??? (unused)
        2. string file
        3. uint64 size
        4. string ext Extension
        5. uint number of attributes
           1. uint attribute number
           2. uint attribute

Peer Code 40

Transfer Request

Function Names

Museekd: PTransferRequest
Nicotine: TransferRequest

Description

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

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

Data Order

• Send
  1. uint direction
  2. uint ticket
  3. string filename
  4. Check contents of direction
     • uint64 filesize if direction == 1
• Receive
  1. uint direction
  2. uint ticket
  3. string filename
  4. Check contents of direction
     • uint64 filesize if direction == 1

Peer Code 41 a

Upload Reply

Function Names

Museekd: PUploadReply
Nicotine: TransferResponse

Description

Response to TransferRequest - either we (or the other peer) agrees, or tells the reason for rejecting the file transfer.

Data Order

• Send
  1. uint ticket
  2. bool allowed
  3. Check contents of allowed
     • uint64 filesize if allowed == 1
     • string reason if allowed == 0
• Receive
  • No Message

Peer Code 41 b

Download Reply

Function Names

Museekd: PDownloadReply
Nicotine: TransferResponse

Description

DEPRECATED, use QueueUpload to request files

Response to TransferRequest - either we (or the other peer) agrees, or tells the reason for rejecting the file transfer.

Data Order

• Send
  1. uint ticket
  2. bool allowed
  3. Check contents of allowed
     • string reason if allowed == 0
• Receive
  • No Message

Peer Code 41 c

Transfer Reply

Function Names

Museekd: PTransferReply
Nicotine: TransferResponse

Description

Response to TransferRequest - either we (or the other peer) agrees, or tells the reason for rejecting the file transfer.

Data Order

• Send
  • No Message
• Receive
  1. uint ticket
  2. bool allowed == 1
  3. Check contents of allowed
     • uint64 filesize if allowed == 1
     • string reason if allowed == 0

Peer Code 42

Upload Placehold

Function Names

Museekd: PUploadPlacehold
Nicotine: PlaceholdUpload

Description

OBSOLETE, no longer used

Data Order

• Send
  1. string filename
• Receive
  1. string filename

Peer Code 43

Queue Upload

Function Names

Museekd: PQueueDownload
Nicotine: QueueUpload

Description

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 an upload request.

Data Order

• Send
  1. string filename
• Receive
  1. string filename

Peer Code 44

Place In Queue Reply

Function Names

Museekd: PPlaceInQueueReply
Nicotine: PlaceInQueue

Description

The peer replies with the upload queue placement of the requested file.

Data Order

• Send
  1. string filename
  2. uint place
• Receive
  1. string filename
  2. uint place

Peer Code 46

Upload Failed

Function Names

Museekd: PUploadFailed
Nicotine: UploadFailed

Description

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

Data Order

• Send
  1. string filename
• Receive
  1. string filename

Peer Code 50

Upload Denied

Function Names

Museekd: PQueueFailed
Nicotine: UploadDenied

Description

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.

Data Order

• Send
  1. string filename
  2. string reason
• Receive
  1. string filename
  2. string reason

Peer Code 51

Place In Queue Request

Function Names

Museekd: PPlaceInQueueRequest
Nicotine: PlaceInQueueRequest

Description

This message is sent when asking for the upload queue placement of a file.

Data Order

• Send
  1. string filename
• Receive
  1. string filename

Peer Code 52

Upload Queue Notification

Function Names

Museekd: PUploadQueueNotification
Nicotine: UploadQueueNotification

Description

DEPRECATED, sent by Soulseek NS but not SoulseekQt

This message is sent to inform a peer about an upload attempt initiated by us.

Data Order

• Send
  • Empty Message
• Receive
  • Empty Message

File Messages

Send	Receive
Send to Peer	Receive from Peer

These messages are sent to peers over a ‘F’ connection, and do not have messages codes associated with them.

File Connection Message Format

Message Contents
…

File Connection Message Index

Message
File Request
File Offset

File Request

Function Names

Nicotine: FileRequest

Description

We sent this to a peer via a ‘F’ connection to tell them that we want to start uploading a file. The token is the same as the one previously included in the TransferRequest message.

Data Order

• Send
  • uint token
• Receive
  • uint token

File Offset

Function Names

Nicotine: FileOffset

Description

We send this to the uploading peer at the beginning of a ‘F’ connection, to tell them how many bytes of the file we’ve previously downloaded. If none, the offset is 0.

Data Order

• Send
  • uint64 offset
• Receive
  • uint64 offset

Distributed Messages

Send	Receive
Send to Node	Receive from Node

In museekd 0.1.13, these messages are sent and received in Museek/DistribConnection.cc and defined in Museek/DistribMessages.hh. Since museekd 0.2, they are defined in museekd/distributedmessages.h.

In Nicotine, these messages are matched to their message number in slskproto.py in the SlskProtoThread function, defined in slskmessages.py and callbacks for the messages are set in pynicotine.py.

The Message format

Message Length	Code	Message Contents
4 Bytes	1 Byte	…

Message Index

Code	Message	Status
0	Ping
3	Search Request
4	Branch Level
5	Branch Root
7	Child Depth	Deprecated
93	Embedded Message

Distributed Code 0

Ping

Description

Send it every 60 sec.

Function Names

Museekd: DPing
Nicotine: DistribAlive

Data Order

• Send
  • Empty Message
• Receive
  1. uint unknown

Distributed Code 3

Search Request

Description

Search request that arrives through the distributed network. We transmit the search request to our child peers.

Function Names

Museekd: DSearchRequest
Nicotine: DistribSearch

Data Order

• Send
  1. uint unknown
  2. string username
  3. uint ticket
  4. string query
• Receive
  1. uint unknown
  2. string username
  3. uint ticket
  4. string query

Distributed Code 4

Branch Level

Description

We tell our distributed children what our position is in our branch (xth generation) on the distributed network.

Function Names

Museekd: DBranchLevel
Nicotine: DistribBranchLevel

Data Order

• Send
  1. int branch level
• Receive
  1. int branch level

Distributed Code 5

Branch Root

Description

We tell our distributed children the username of the root of the branch we’re in on the distributed network.

Function Names

Museekd: DBranchRoot
Nicotine: DistribBranchRoot

Data Order

• Send
  1. string branch root
• Receive
  1. string branch root

Distributed Code 7

Child Depth

Description

DEPRECATED, sent by Soulseek NS but not SoulseekQt

We tell our distributed parent the maximum number of generation of children we have on the distributed network.

Function Names

Museekd: DChildDepth
Nicotine: DistribChildDepth

Data Order

• Send
  1. uint child depth
• Receive
  1. uint child depth

Distributed Code 93

Embedded Message

A branch root sends us an embedded distributed message. The only type of distributed message sent at present is DistribSearch (distributed code 3). We unpack the distributed message and distribute it to our child peers.

Function Names

Museekd: Unimplemented
Nicotine: DistribEmbeddedMessage

Data Order

• Send
  1. uchar distributed code
  2. bytes distributed message Raw message associated with distributed code
• Receive
  1. uchar distributed code
  2. bytes distributed message Raw message associated with distributed code

Museek Data Types

StringMap

• std::map<std::string, std::string>

StringList

• std::vector<std::string>

WStringList

• std::vector<std::wstring> WStringList

WTickers

• std::map<std::string, std::wstring>

Recommendations, SimilarUsers, RoomList

• std::map<std::string, uint>

NetInfo

• std::map<std::string, std::pair<std::string, uint> >

UserData

1. uint status Online Status
2. uint avgspeed Average Speed
3. uint64 uploadnum Number of uploaded files. The value changes when sending a SendUploadSpeed server message, and is likely used by the server to calculate the average speed.
4. uint files Files shared
5. uint dirs Directories shared
6. bool slotsfree Slots free
7. string countrycode Uppercase country code

RoomData

• std::map<std::string, UserData>

Folder

• std::map<std::string, FileEntry>

Shares

• std::map<std::string, Folder>

WFolder

• std::map<std::wstring, FileEntry>

Folders

• std::map<std::string, Shares>

WShares

• std::map<std::wstring, WFolder>

WFolders

• std::map<std::wstring, WShares>

off_t

• Packed as a 64bit Integer

Credits

This documentation exists thanks to efforts from the following projects:

• Nicotine+ (Hyriand, daelstorm, mathiascode)
• Museek+ (lbponey)
• SoleSeek
• PySoulSeek

This site is open source. Improve this page.