org.asteriskjava.manager.event

Class PeerStatusEvent

java.lang.Object

java.util.EventObject

org.asteriskjava.manager.event.ManagerEvent

org.asteriskjava.manager.event.PeerStatusEvent

All Implemented Interfaces:

Serializable

public class PeerStatusEvent
extends ManagerEvent

A PeerStatusEvent is triggered when a SIP or IAX client attempts to registrer at this asterisk server.

This event is implemented in channels/chan_iax2.c and channels/chan_sip.c

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	STATUS_LAGGED
static String	STATUS_REACHABLE
static String	STATUS_REGISTERED
static String	STATUS_REJECTED
static String	STATUS_UNREACHABLE
static String	STATUS_UNREGISTERED

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
PeerStatusEvent(Object source)

Method Summary

Modifier and Type	Method and Description
String	getAddress() Returns the IP address of the peer that registered.
String	getCause() Returns the cause of a rejection or unregistration.
String	getChannelType() Returns the type of channel that registers, that is "IAX2" for an IAX2 channel or "SIP" for a SIP channel.
String	getPeer() Returns the name of the peer that registered.
String	getPeerStatus() Returns the registration state.
Integer	getPort() Returns the port of the peer that registered.
Integer	getTime() Returns the ping time of the client if status equals "Reachable" or "Lagged"; if the status equals "Unreachable" it returns how long the last response took (in ms) for IAX peers or -1 for SIP peers.
void	setAddress(String address)
void	setCause(String cause) Sets the cause of the rejection or unregistration.
void	setChannelType(String channelType) Sets the type of channel that registers.
void	setPeer(String peer) Sets the name of the peer that registered.
void	setPeerStatus(String peerStatus) Sets the registration state.
void	setPort(Integer port)
void	setTime(Integer time)

Methods inherited from class org.asteriskjava.manager.event.ManagerEvent

appendPropertyIfNotNull, getDateReceived, getFile, getFunc, getLine, getPrivilege, getSequenceNumber, getServer, getTimestamp, setDateReceived, setFile, setFunc, setLine, setPrivilege, setSequenceNumber, setServer, setTimestamp, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_REGISTERED

public static final String STATUS_REGISTERED

See Also:

Constant Field Values

STATUS_UNREGISTERED

public static final String STATUS_UNREGISTERED

See Also:

Constant Field Values

STATUS_REACHABLE

public static final String STATUS_REACHABLE

See Also:

Constant Field Values

STATUS_LAGGED

public static final String STATUS_LAGGED

See Also:

Constant Field Values

STATUS_UNREACHABLE

public static final String STATUS_UNREACHABLE

See Also:

Constant Field Values

STATUS_REJECTED

public static final String STATUS_REJECTED

See Also:

Constant Field Values

Constructor Detail

PeerStatusEvent

public PeerStatusEvent(Object source)

Parameters:

source -

Method Detail

getChannelType

public String getChannelType()

Returns the type of channel that registers, that is "IAX2" for an IAX2 channel or "SIP" for a SIP channel.

Available since Asterisk 1.6.

Returns:

the type of channel that registers.

Since:

1.0.0

setChannelType

public void setChannelType(String channelType)

Sets the type of channel that registers.

Parameters:

channelType - the type of channel that registers

Since:

1.0.0

getPeer

public String getPeer()

Returns the name of the peer that registered.

The peer name includes the channel type prefix. So if you receive a PeerStatusEvent for a SIP peer defined as "john" in sip.conf this method returns "SIP/john".
Peer names for IAX clients start with "IAX2/", peer names for SIP clients start with "SIP/".

Returns:

the peer's name including the channel type.

setPeer

public void setPeer(String peer)

Sets the name of the peer that registered.

getPeerStatus

public String getPeerStatus()

Returns the registration state.

This may be one of

• Registered
• Unregistered
• Reachable
• Lagged
• Unreachable
• Rejected (IAX only)

setPeerStatus

public void setPeerStatus(String peerStatus)

Sets the registration state.

getCause

public String getCause()

Returns the cause of a rejection or unregistration.

For IAX peers this is set only if the status equals "Rejected".

For SIP peers this is set if the status equals "Unregistered" and the peer was unregistered due to an expiration. In that case the cause is set to "Expired".

Returns:

the cause of a rejection or unregistration.

setCause

public void setCause(String cause)

Sets the cause of the rejection or unregistration.

getTime

public Integer getTime()

Returns the ping time of the client if status equals "Reachable" or "Lagged"; if the status equals "Unreachable" it returns how long the last response took (in ms) for IAX peers or -1 for SIP peers.

setTime

public void setTime(Integer time)

getAddress

public String getAddress()

Returns the IP address of the peer that registered. Only available for SIP channels.

Available since Asterisk 1.6.

Returns:

the IP address of the peer that registered or null if not available.

Since:

1.0.0

setAddress

public void setAddress(String address)

getPort

public Integer getPort()

Returns the port of the peer that registered. Only available for SIP channels.

Available since Asterisk 1.6.

Returns:

the port of the peer that registered or null if not available.

Since:

1.0.0

setPort

public void setPort(Integer port)