Editing Virtual1's Hotline Server Protocol Guide (section)

===Chapter 2: OBJECTS===

objects are sent under the following format:

 • object header
   • short (object ID number)
   • short (object length)  does not count these four header bytes
 • object data
   if it's a number >=0 and <65536:
     • short (number)
   if it's a number >65535:
     • long (number)
   if it's a number <0:
     • long (232+number)
   if it is a string:
     • string  encoded strings have all chars EOF $FF)
   if it is a filelistentry
     • file type  four characters, or "fldr" if folder, or
                  "alis" if unresolved alias
     • file creator  four characters, or long(0) if folder
     • long (file size in bytes, zero if folder)
     • long (contained items, zero if app/doc)
     • long (filename length)
     • string (filename)
   if it is a Path
     • short (directory levels)
     • one or more directory levels
       • short (0)  not sure what it's for
       • byte (length of dir name)
       • string (dir name)
   if it is a userlistentry
     • short (socket)
     • short (icon)
     • short (status)
     • short (length of nick)
     • string (nick)
   if it is a datetime
     • short (base year - usually 1904)
     • short (0)
     • long (number of seconds this date is from midnight, jan 1, base year)
   if it is a resumeinfo
     • "RFLT" - Resume FiLe Transfer
     • short (1)
     • 34 zeros = 8 x long(0)  +  1 x short(0)
     • short (2)
     • Data descriptor
       • "DATA"
       • long (index to start at)
       • long (0)
       • long (0)
     • Resource descriptor
       • "MACR"
       • long (index to start at)
       • long (0)
       • long (0)
   if it is a newsgroup
     • const ($33 31 31 33 - no idea why, but it's always there)
     • long (post count)
     • pstring (category name)
     • const ($00)
     • posts
       • long (thread ID)
       • long (date)
       • long (parent thread ID)
       • const ($00 00 00 00)
       • short (message element count)
       • pstring (subject)
       • pstring (poster)
       • message elements
         • pstring (mime type)
         • short (post size?)
   if it's a newsfolderitem
     • byte (item type: $01=folder, $0A=category)
     • raw data (folder/category name, no length byte)


Integer objects are preceeded by a length for a reason. Do not assume that
just because the object you are expecting can only be a number 0-50 ,that
it will have to be sent as a short. It could be sent as a long, and we don't
want to break the socket for such a simple misunderstanding. The reverse is
true for longs, they may be sending an icon number that is 5, and decide to
save a few bytes and send it as a short. BEWARE.

client objects and their ID numbers:
 ID#  Name           Object Type                               
 100  errormsg       string
 101  message        string
 102  nick           string
 103  socket         number
 104  icon           number
 105  login          encoded string  NOT encoded in transaction #352
 106  password       encoded string
 107  xferID         number  the ID number of the file transfer (usually 32 bit)
 108  xfersize       number  size of file xfer, in bytes (smaller for resumes!!)
 109  parameter      number  specifies icon for broadcast, also emote flag
 110  privs          eight bytes  can make 64 flags, only use 27
 111  ???
 112  status         number  0=black non-idle
 113  ban            short (1)    include to make a kick into a ban
 114  chatwindow     four random bytes??  example: 84 47 5E 02 
 115  subject        string   the new subject of a chat window
 
 116 waiting count object
 200  fileentry      filelistentry
 201  filename       string
 202  path           path
 203  resumeinfo     resume
 204  resumeflag     short (1)
 205  infolongtype   string   "Text File"
 206  infocreator    string   "Simpletext"
 207  infosize       number
 208  infocreated    datetime
 209  infomodified   datetime
 210  comment        string
 211  newfilename    string
 212  targetpath     path       
 213  infotype       string  the 4-char macos type code (redundant, client already has C/T)
 214  Quote          string
 300  userlistentry  userlistentry
 320  newsfolderitem newsfolderitem
 321  catlist        newsgroup
 322  category       string
 325  newspath       path    this one revealed to me its "true nature" in v1.5 !
 326  threadID       number  the serial number of a message, for threading
 327  newstype       string
 328  newssubject    string
 329  author         string
 330  newsdate       date
 331  prevthread     number
 332  nextthread     number
 333  newsdata       string
 334  unknown!       number?

Note! XferSize is the actual number of bytes in the file if it's a download, but
it's the size of the file datablock (length of file - 146 - length of filename -
length of comment) if it's an upload! :P (that's length PLUS 146 PLUS filename)