> ## Documentation Index > Fetch the complete documentation index at: https://mintlify.com/nicotine-plus/nicotine-plus/llms.txt > Use this file to discover all available pages before exploring further. # Protocol Messages (slskmessages) > Soulseek protocol message definitions and utilities The `slskmessages` module defines all protocol messages used in the Soulseek network. ## Message Types ### MessageType Constants Internal application messages Server protocol messages Peer protocol messages File transfer messages Distributed network messages ## Status Constants ### UserStatus User is offline User is away User is online ### TransferRejectReason Transfer is queued User is banned File is not shared Queue file limit reached ## Server Messages ### Login Authenticate with the Soulseek server. ```python theme={null} from pynicotine.slskmessages import Login msg = Login( username="myusername", passwd="mypassword", version=160, minorversion=3 ) ``` Username for authentication Password for authentication Client version number Whether login succeeded (received from server) Reason for login failure if unsuccessful ### WatchUser Subscribe to status updates for a user. ```python theme={null} from pynicotine.slskmessages import WatchUser msg = WatchUser(user="username") ``` Username to watch Whether the user exists User status (0=offline, 1=away, 2=online) Average upload speed Number of shared files Number of shared directories ### FileSearch Initiate a global file search. ```python theme={null} from pynicotine.slskmessages import FileSearch msg = FileSearch(token=12345, text="music artist album") ``` Unique search token for tracking results Search query ### JoinRoom Join a chat room. ```python theme={null} from pynicotine.slskmessages import JoinRoom msg = JoinRoom(room="music", private=False) ``` Name of the room to join Whether the room is private List of UserData objects for room members Room owner (for private rooms) List of room operators (for private rooms) ## Peer Messages ### SharedFileListRequest Request a peer's shared file list. ```python theme={null} from pynicotine.slskmessages import SharedFileListRequest msg = SharedFileListRequest() ``` ### FileSearchResponse Respond to a search request with matching files. ```python theme={null} from pynicotine.slskmessages import FileSearchResponse msg = FileSearchResponse( search_username="myusername", token=12345, shares=file_list, freeulslots=True, ulspeed=1000, inqueue=0 ) ``` Username sending the results Search token from the request List of matching files with metadata Whether upload slots are available Average upload speed Number of files queued for this user ### TransferRequest Request to initiate a file transfer. ```python theme={null} from pynicotine.slskmessages import TransferRequest, TransferDirection msg = TransferRequest( direction=TransferDirection.UPLOAD, token=67890, file="folder\\filename.mp3", filesize=1234567 ) ``` 0 for download, 1 for upload Unique transfer token Virtual file path Size of file in bytes ### QueueUpload Queue a file for upload. ```python theme={null} from pynicotine.slskmessages import QueueUpload msg = QueueUpload(file="folder\\filename.mp3") ``` Virtual file path to queue ## Utility Functions ### initial\_token() ```python theme={null} def initial_token() ``` Generates a random initial token for searches and transfers. Random token value ### increment\_token() ```python theme={null} def increment_token(token) ``` Increments a token, wrapping at UINT32 limit. Current token value Incremented token value ```python Example: Token Management theme={null} from pynicotine.slskmessages import initial_token, increment_token # Generate initial token token = initial_token() print(f"Initial token: {token}") # Increment for each new search token = increment_token(token) print(f"Next token: {token}") ``` ## File Attributes The `FileAttributes` class stores audio file metadata. Audio bitrate in kbps Duration in seconds Variable bitrate flag (0 or 1) Sample rate in Hz Bit depth for lossless audio ```python Example: File Attributes theme={null} from pynicotine.slskmessages import FileAttributes attrs = FileAttributes( bitrate=320, length=245, vbr=0, sample_rate=44100 ) print(f"Bitrate: {attrs.bitrate} kbps") print(f"Duration: {attrs.length} seconds") ``` ## Message Packing/Unpacking All message classes inherit from `SlskMessage` and implement: * `make_network_message()` - Serializes message to bytes * `parse_network_message()` - Deserializes bytes to message Messages use little-endian byte order and length-prefixed strings for network transmission. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.