Package org.red5.server.net.rtmp.status

Class StatusObject

java.lang.Object

org.red5.server.net.rtmp.status.StatusObject

All Implemented Interfaces:

IExternalizable

Direct Known Subclasses:

RuntimeStatusObject

public class StatusObject
extends Object
implements IExternalizable

Status object that is sent to client with every status event

Author:

The Red5 Project, Luke Hubbard, Codegent Ltd (luke@codegent.com)

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Object>	additional
protected Object	application
protected String	code
protected String	description
static final String	ERROR	Constant WARNING="warning"
protected String	level
static final String	STATUS	Constant WARNING="warning"
static final String	WARNING	Constant WARNING="warning"

Constructor Summary

Constructors

Constructor	Description
StatusObject()	Constructs a new StatusObject.
StatusObject(String code, String level)	Constructor for StatusObject.
StatusObject(String code, String level, String description)	Constructor for StatusObject.

Method Summary

Modifier and Type	Method	Description
Status	asStatus()	Generate Status object that can be returned through a RTMP channel.
Object	getApplication()	Getter for property 'application'.
String	getCode()	Getter for property 'code'.
String	getDescription()	Getter for property 'description'.
String	getLevel()	Getter for property 'level'.
void	readExternal(IDataInput in)	Load custom object from stream.
void	setAdditional(String name, Object value)	Setter for the field additional.
void	setApplication(Object application)	Setter for property 'application'.
void	setCode(String code)	Setter for property 'code'.
void	setDescription(String description)	Setter for property 'description'.
void	setLevel(String level)	Setter for property 'level'.
String	toString()
void	writeExternal(IDataOutput out)	Store custom object to stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ERROR

public static final String ERROR

Constant WARNING="warning"

See Also:

• Constant Field Values

STATUS

public static final String STATUS

Constant WARNING="warning"

See Also:

• Constant Field Values

WARNING

public static final String WARNING

Constant WARNING="warning"

See Also:

• Constant Field Values

code

protected String code

level

protected String level

description

protected String description

application

protected Object application

additional

protected Map<String,Object> additional

Constructor Details

StatusObject

public StatusObject()

Constructs a new StatusObject.

StatusObject

public StatusObject(String code,
 String level)

Constructor for StatusObject.

Parameters:

code - a String object

level - a String object

StatusObject

public StatusObject(String code,
 String level,
 String description)

Constructor for StatusObject.

Parameters:

code - a String object

level - a String object

description - a String object

Method Details

getCode

public String getCode()

Getter for property 'code'.

Returns:

Value for property 'code'.

setCode

public void setCode(String code)

Setter for property 'code'.

Parameters:

code - Value to set for property 'code'.

getDescription

public String getDescription()

Getter for property 'description'.

Returns:

Value for property 'description'.

setDescription

public void setDescription(String description)

Setter for property 'description'.

Parameters:

description - Value to set for property 'description'.

getLevel

public String getLevel()

Getter for property 'level'.

Returns:

Value for property 'level'.

setLevel

public void setLevel(String level)

Setter for property 'level'.

Parameters:

level - Value to set for property 'level'.

setApplication

public void setApplication(Object application)

Setter for property 'application'.

Parameters:

application - Value to set for property 'application'.

getApplication

public Object getApplication()

Getter for property 'application'.

Returns:

Value for property 'application'.

setAdditional

public void setAdditional(String name,
 Object value)

Setter for the field additional.

Parameters:

name - a String object

value - a Object object

asStatus

public Status asStatus()

Generate Status object that can be returned through a RTMP channel.

Returns:

status

toString

public String toString()

Overrides:

toString in class Object

readExternal

public void readExternal(IDataInput in)

Load custom object from stream.

Specified by:

readExternal in interface IExternalizable

Parameters:

in - object to be used for data loading

writeExternal

public void writeExternal(IDataOutput out)

Store custom object to stream.

Specified by:

writeExternal in interface IExternalizable

Parameters:

out - object to be used for data storing