RTMP/E

 getEdgeConnectionStats(appInst:String, groupid:String) : Object

HTTP

 http://www.example.com:1111/admin/getEdgeConnectionStats?auser=username&apswd=password&appInst=name&groupid=string

Gets statistics for a particular edge server connection. This connection is special because it multiplexes for more than one client connection and contains a unique statistic called members_count. Edge connections are established from one server to another as proxies.

You can call getEdgeConnections() to get a value for groupid.

This method was formerly known as getGroupStats().

Availability

Flash Media Server 2.0.

Parameters

appInst

A String indicating the name of the instance of the application on which the virtual client resides, in the form application_name/instance_name. You must specify both the application name and the instance name, separated by a slash (/), even if you want performance statistics for the default instance of the application. For example, to specify the default instance for an application named ChatApp, specify ChatApp/_defInst_.

groupid

A String indicating the group’s client ID.

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 containing the client performance data. The data object has the following properties:

Property

Description

connect_time

ActionScript Date object; time the application connected to the server.

protocol

String; protocol used by the client to connect to the server (rtmp, rtmpe, or rtmpt).

msg_in

Number; total number of messages processed by this application.

msg_out

Number; total number of messages sent by this application.

msg_dropped

Number; total number of messages dropped by this application.

bytes_in

Number; total number of bytes read by this application.

bytes_out

Number; total number of bytes written by this application.

msg_queue

Object; client message queue statistics.

total_queues

Number; total number of queues for this client.

audio

Number; total number of audio messages in all audio queues.

video

Number; total number of video messages in all video queues.

other

Number; total number of cmd/data messages in the “other” queue.

stream_ids

Array; an array of numbers (stream IDs).

members_count

Number; the number of clients multiplexing on this group connection.

HTTP

If the call succeeds, it returns XML with the following structure:

 <result>   <level>status</level>   <code>NetConnection.Call.Success</code>   <timestamp>10/23/2007 12:43:47 PM</timestamp>   <data>   <name>_defaultRoot_:_defaultVHost_:::_2</name>   <bytes_in>3283</bytes_in>   <bytes_out>3878</bytes_out>   <msg_in>5</msg_in>   <msg_out>1</msg_out>   <msg_dropped>0</msg_dropped>   <connect_time>10/23/2007 12:16:08 PM</connect_time>   <protocol>rtmp</protocol>   <msg_queue>   <total_queues>1</total_queues>   <audio>0</audio>   <video>0</video>   <other>0</other>   </msg_queue>   <stream_ids />   <members_count>1</members_count>   </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>error</level>   <code>NetConnection.Call.BadValue</code>   <timestamp>10/23/2007 3:30:12 PM</timestamp>   <description>Invalid group ID (0).</description>  </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

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy