$SR

From DCppWiki

Contents

Syntax

$SR <source_nick> <result> <free_slots>/<total_slots><0x05><hub_name> (<hub_ip:listening_port>)[<0x05><target_nick>]|

Description

This command is used to return a file or directory that matches a $Search. All terms in the original query must be present in <result>, and all types and size restrictions in the $Search must be met.

  • <result> is one of the following:
  • <file_name><0x05><file_size> for file results
  • <directory> for directory results
  • The <0x05> characters used above for deliminators are the 5th character in the ASCII character set.
  • Sent by a client when a match to a $Search is found.
  • If the $Search was a passive one, the $SR is returned via the hub connection (TCP). In this case, <0x05><target_nick> must be included on the end of the $SR. The hub must strip the deliminator and <target_nick> before sending the $SR to <target_nick>. If the search was active, it is sent to the IP address and port specified in the $Search via UDP.
  • The port for the hub only needs to specified if its listening port is not the default (411).
  • On UNIX the path delimiter / must be converted to \ for compatibility.
  • DC++ will send a maximum of 5 search results to passive users and 10 to active users.
  • For files containing TTH, the <hub_name> parameter is replaced with TTH:<base32_encoded_tth_hash> (ref: TTH_Hash)

Example

Passive Result

$SR User1 mypathmotd.txt<0x05>437 3/4<0x05>Testhub (10.10.10.10:411)<0x05>User2|

Active Result

$SR User1 mypathmotd.txt<0x05>437 3/4<0x05>Testhub (10.10.10.10:411)|