Difference between revisions of "Onlinesig.dat file"

From AMule Project FAQ
Jump to: navigation, search
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
== File ==
 +
'''Name:''' ''onlinesig.dat''
 +
 +
'''Location:''' ''~/.aMule/''
 +
 +
== Description ==
 
This file is generated by [[eMule]] to inform external applications about it's status. [[aMule]] is able to generate this file too in order to have compatibility with [[eMule]] utilities, but the native [[aMule]] [[signature]] file is [[amulesig.dat_file|amulesig.dat]] (which is much more powerfull than [[eMule]]'s ''onlinesig.dat'').
 
This file is generated by [[eMule]] to inform external applications about it's status. [[aMule]] is able to generate this file too in order to have compatibility with [[eMule]] utilities, but the native [[aMule]] [[signature]] file is [[amulesig.dat_file|amulesig.dat]] (which is much more powerfull than [[eMule]]'s ''onlinesig.dat'').
  
Line 7: Line 13:
 
*clients in queue
 
*clients in queue
  
 +
== Format ==
 
It is composed of two lines separated by a line feed character (with no carriage return character):
 
It is composed of two lines separated by a line feed character (with no carriage return character):
*The first one, when [[aMule]] is offline, will contain a ''0'' (zero) and nothing else, but when [[aMule]] is online, it'll contain a ''1'' (number one) followed by ''|'' (the pipe character) then the name of there server it's currently connected to followed by the pipe character (''|''), then the [[IP]] of the server it's currently connected to followed by the pipe character (''|'') and finally the port it is connected to on that server.
+
*The first one, when [[aMule]] is offline, will contain a ''0'' (zero) and nothing else, but when [[aMule]] is online, it'll contain a ''1'' (number one) followed by ''|'' (the pipe character) then the name of there server it's currently connected to followed by the pipe character (''|''), then the [[IP address|IP]] of the server it's currently connected to followed by the pipe character (''|'') and finally the port it is connected to on that server.
*The second line contains, in this order, the downloading rate, the uploading rate and the number of users on queue, with a pipe character (''|'') between each of them.
+
*The second line contains, in this order, the downloading and uploading speeds (exactly one decimal is shown, neither mor nor less) and the number of users on queue, with a pipe character (''|'') between each of this fields.
  
 
The second line does '''not''' end in a newline character ('\n').
 
The second line does '''not''' end in a newline character ('\n').
  
 
When [[aMule]] (or [[eMule]]) is cleanly closed, the second line contains the same structure but filled with zeros, while the first line will '''only''' contain a single zero (''0'').
 
When [[aMule]] (or [[eMule]]) is cleanly closed, the second line contains the same structure but filled with zeros, while the first line will '''only''' contain a single zero (''0'').
 +
 +
It is very important to notice that the newlines are [http://www.unix.org UNIX] newlines (in hex, ''0xA''), never [http://www.freedos.org DOS] newlines (even if you are using a [http://www.freedos.org DOS] or [http://www.microsofot.com/windows Windows] OS.
 +
 +
== Examples ==
 +
The following is the contents of a valid ''onlinesig.dat'' file when [[aMule]] is online:
 +
 +
''1|eD2k Server|20.34.253.32|4661'' (here goes a [http://www.unix.org UNIX] newline character ''0xA'')<br>
 +
''20.3|12.9|134''
 +
 +
The following is the contents of a valid ''onlinesig.dat'' file when [[aMule]] is offline (or closed but last status while open was online):
 +
 +
''0'' (here goes a [http://www.unix.org UNIX] newline character ''0xA'')<br>
 +
''0.0|0.0|0''
 +
 +
 +
[[Category:Program Files]]

Latest revision as of 18:52, 11 January 2011

File

Name: onlinesig.dat

Location: ~/.aMule/

Description

This file is generated by eMule to inform external applications about it's status. aMule is able to generate this file too in order to have compatibility with eMule utilities, but the native aMule signature file is amulesig.dat (which is much more powerfull than eMule's onlinesig.dat).

eMule's signature file reports the following basic status information:

  • whether it is online or not
  • which server it's connected to
  • upload and download rate
  • clients in queue

Format

It is composed of two lines separated by a line feed character (with no carriage return character):

  • The first one, when aMule is offline, will contain a 0 (zero) and nothing else, but when aMule is online, it'll contain a 1 (number one) followed by | (the pipe character) then the name of there server it's currently connected to followed by the pipe character (|), then the IP of the server it's currently connected to followed by the pipe character (|) and finally the port it is connected to on that server.
  • The second line contains, in this order, the downloading and uploading speeds (exactly one decimal is shown, neither mor nor less) and the number of users on queue, with a pipe character (|) between each of this fields.

The second line does not end in a newline character ('\n').

When aMule (or eMule) is cleanly closed, the second line contains the same structure but filled with zeros, while the first line will only contain a single zero (0).

It is very important to notice that the newlines are UNIX newlines (in hex, 0xA), never DOS newlines (even if you are using a DOS or Windows OS.

Examples

The following is the contents of a valid onlinesig.dat file when aMule is online:

1|eD2k Server|20.34.253.32|4661 (here goes a UNIX newline character 0xA)
20.3|12.9|134

The following is the contents of a valid onlinesig.dat file when aMule is offline (or closed but last status while open was online):

0 (here goes a UNIX newline character 0xA)
0.0|0.0|0