Packagenet.user1.reactor
Classpublic class ConnectionRefusal
InheritanceConnectionRefusal Inheritance Object

Since : Reactor 1.1.1

A simple data class describing a connection refusal by Union Server.

See also

ReactorEvent.CONNECT_REFUSED


Public Variables
 VariableDefined By
  banDuration : Number
When the refusal-reason code for this ConnectionRefusal object is ConnectionRefusalReason.BANNED, banDuration indicates the length of the ban on this client's address, in milliseconds.
ConnectionRefusal
  bannedAt : Number
When the refusal-reason code for this ConnectionRefusal object is ConnectionRefusalReason.BANNED, bannedAt indicates the time at which this client's address was banned by Union Server.
ConnectionRefusal
  banReason : String
When the refusal-reason code for this ConnectionRefusal object is ConnectionRefusalReason.BANNED, banReason indicates the cause of the ban on this client's address, as an arbitrary string.
ConnectionRefusal
  description : String
Returns an arbitrary string providing information about the condition that led to the connection refusal by Union Server.
ConnectionRefusal
  reason : String
Returns the reason for a connection refusal by Union Server.
ConnectionRefusal
Public Methods
 MethodDefined By
  
ConnectionRefusal(reason:String, description:String)
Constructor.
ConnectionRefusal
Variable Descriptions
banDurationvariable
public var banDuration:Number

Since : Reactor 1.1.1

When the refusal-reason code for this ConnectionRefusal object is ConnectionRefusalReason.BANNED, banDuration indicates the length of the ban on this client's address, in milliseconds.

See also

bannedAtvariable 
public var bannedAt:Number

Since : Reactor 1.1.1

When the refusal-reason code for this ConnectionRefusal object is ConnectionRefusalReason.BANNED, bannedAt indicates the time at which this client's address was banned by Union Server. The time is specified in milliseconds-from-1970 format UTC time, according to the server's clock.

See also

banReasonvariable 
public var banReason:String

Since : Reactor 1.1.1

When the refusal-reason code for this ConnectionRefusal object is ConnectionRefusalReason.BANNED, banReason indicates the cause of the ban on this client's address, as an arbitrary string. For example: "You were banned for inappropriate use of language".

See also

descriptionvariable 
public var description:String

Since : Reactor 1.1.1

Returns an arbitrary string providing information about the condition that led to the connection refusal by Union Server.

See also

reasonvariable 
public var reason:String

Since : Reactor 1.1.1

Returns the reason for a connection refusal by Union Server. The refusal-reason string is either one of the constants defined by the ConnectionRefusalReason class or an arbitrary refusal-reason-code generated by a custom server-side module. When reason is ConnectionRefusalReason.BANNED, the time, duration, and cause of the ban will be available via the bannedAt, banDuration, and banReason variables.

See also

Constructor Description
ConnectionRefusal()Constructor
public function ConnectionRefusal(reason:String, description:String)

Constructor.

Parameters
reason:String
 
description:String