Rams Class Reference

Class containing interface methods for RAMS API. More...

Inherits Raws.

List of all members.

Public Member Functions
	getTrafficFeed ($path=null, $query=null)
	Retrieve the feed for a RAMS Traffic instance.
	getStorageFeed ($path=null, $query=null)
	Retrieve the feed for a RAMS Storage instance.
	getFilterFeed ($path=null, $query=null)
	Retrieve the feed for a RAMS Filter instance.
	getGeoDomainFeed ($query=null)
	Retrieve the feed for a RAMS Domain instance.
	getGeoCityFeed ($query=null)
	Retrieve the feed for a RAMS City instance.
	getGeoHostFeed ($query=null)
	Retrieve the feed for a RAMS Host instance.
	getTotalFeed ($query=null)
	Retrieve the feed for a RAMS Total instance.
	getConcurrentV1Feed ($query=null)
	Retrieve the feed for a RAMS Concurrent instance.
	getTrafficTypeFeed ($query=null)
	Retrieve the feed for a RAMS Concurrent instance.
	getPayedFeed ($query=null)
	Retrieve the feed for a RAMS Payed instance.
	getUsersFeed ()
	Retrieve the feed for a RAMS Users instance.
	getUsedFeed ($query=null, $username=null)
	Retrieve the feed for a RAMS Used instance.

---

Detailed Description

Class containing interface methods for RAMS API.

Examples:

rams_concurrent.php, rams_customer_resources.php, rams_geo.php, rams_set_traffic_limit.php, rams_storage.php, rams_total.php, and rams_ttype.php.

---

Member Function Documentation

Rams.getTrafficFeed	(	$	path = null,
		$	query = null
	)

Retrieve the feed for a RAMS Traffic instance.

Parameters:

	string	$path The relative path to the directory.
	TrafficQuery	$query An object of type TrafficQuery, or null for no query-string.

Returns:

Rams TrafficFeed object

Rams.getStorageFeed	(	$	path = null,
		$	query = null
	)

Retrieve the feed for a RAMS Storage instance.

Parameters:

	string	$path The relative path to the directory.
	StorageQuery	$query An object of type StorageQuery, or null for no query-string.

Returns:

Rams StorageFeed object

Rams.getFilterFeed	(	$	path = null,
		$	query = null
	)

Retrieve the feed for a RAMS Filter instance.

Parameters:

	string	$path The relative path to the directory.
	FilterQuery	$query An object of type FilterQuery, or null for no query-string.

Returns:

Rams FilterFeed object

Rams.getGeoDomainFeed

(

$

query = null

)

Retrieve the feed for a RAMS Domain instance.

Parameters:

string

$path The relative path to the directory.

Returns:

Rams GeoFeed object

Rams.getGeoCityFeed

(

$

query = null

)

Retrieve the feed for a RAMS City instance.

Parameters:

string

$path The relative path to the directory.

Returns:

Rams GeoFeed object

Rams.getGeoHostFeed

(

$

query = null

)

Retrieve the feed for a RAMS Host instance.

Parameters:

string

$path The relative path to the directory.

Returns:

Rams GeoFeed object

Rams.getTotalFeed

(

$

query = null

)

Retrieve the feed for a RAMS Total instance.

Parameters:

TotalQuery

$query An object of type TotalQuery, or null for no query-string.

Returns:

Rams TotalFeed object

Rams.getConcurrentV1Feed

(

$

query = null

)

Retrieve the feed for a RAMS Concurrent instance.

Parameters:

ConcurrentQuery

$query An object of type TrafficQuery, or null for no query-string.

Returns:

Rams ConcurrentFeed object

Rams.getTrafficTypeFeed

(

$

query = null

)

Retrieve the feed for a RAMS Concurrent instance.

Parameters:

	string	$path The relative path below the virtual 'rambla_live_streams' directory, or null (for a listing request).
	ConcurrentQuery	$query An object of type TrafficQuery, or null for no query-string.

Returns:

Rams ConcurrentFeed object Retrieve the feed for a RAMS traffic-type instance.

Parameters:

TrafficTypeQuery

$query An object of type TtypeQuery, or null for no query-string.

Returns:

Rams TrafficTypeFeed object

Rams.getPayedFeed

(

$

query = null

)

Retrieve the feed for a RAMS Payed instance.

Parameters:

PayedQuery

$query An object of type PayedQuery, or null for no query-string.

Returns:

Rams PayedFeed object

Rams.getUsersFeed

(

)

Retrieve the feed for a RAMS Users instance.

Returns:

Rams UsersFeed object

Rams.getUsedFeed	(	$	query = null,
		$	username = null
	)

Retrieve the feed for a RAMS Used instance.

Parameters:

string

$username The name of the user account, if used credits are requested for a specific user.

Returns:

Rams UsedFeed object

---