RTMP/E
getUserStats(appInst:String, userid:String) : Object
HTTP
http://www.example.com:1111/admin/getUserStats?auser=username&apswd=password&appInst=name&userid=ID
Gets the performance data for the connection of a specified user.
Availability
Flash Communication Server 1.0.
Parameters
appInst
A String indicating the name of the instance of the application, in the form application_name/instance_name.
userid
A String indicating the user ID, as assigned by the server. You can retrieve a user ID with the getUsers() method.
auser
A String indicating the user name of the administrator.
apswd
A String indicating the password of the administrator.
Returns
RTMP/E
If the call succeeds, the server sends a reply information object with a level property of status, a code property of NetConnection.Call.Success, and a data property that is an object. The data object has the following properties:
Property |
Description |
|---|---|
connect_time |
ActionScript Date object; time, in seconds, that the user has been connected to the specified instance of the application. |
msg_in |
Number; total number of messages processed by this user. |
msg_out |
Number; total number of messages sent by this user. |
msg_dropped |
Number; total number of messages dropped by this user. |
bytes_in |
Number; total number of bytes read by this user. |
bytes_out |
Number; total number of bytes written by this user. |
msg_queue |
Object that contains the client message queue statistics. The msg_queue object contains the following properties: total_queues: Total number of queues for this client. audio: Total number of audio messages in all audio queues. video: Total number of video messages in all video queues. other: Total number of command/data messages in the other queue. |
protocol |
String; protocol used by the client to connect to the server (rtmp, rtmpe, rtmpt, or rtmps.) |
stream_ids |
Array of numbers that represent the stream IDs. |
If the call fails, the server sends a reply information object with a level property of error and a code property of NetConnection.Call.Failed or a more specific value, if available. Some objects might also have a description property that contains a string describing the cause of the failure.
HTTP
If the call succeeds, it returns XML with the following structure:
<result> <level></level> <code></code> <timestamp></timestamp> <data></data> </result>Nested in the data element are elements for each property of the data object listed in the RTMP/E section.
If the call fails, it returns XML with the following structure:
<result> <level></level> <code></code> <description></description> <timestamp></timestamp> </result>The XML elements contain the same information as the Object properties returned in an RTMP/E call.
Note: The timestamp response over HTTP is formatted differently on Windows (9/23/2007 6:16:40 PM) and Linux (Sun 23 Sep 2007 06:16:40 PM IST).
See also
