org.henrya.pingapi.api

Class PingEvent

java.lang.Object

org.henrya.pingapi.api.PingEvent

public class PingEvent
extends java.lang.Object

An event that is called when the server receives a ping

Author:

Henry Anderson

Constructor Summary

Constructors

Constructor and Description
PingEvent(PingReply reply) Created a new PingEvent instance

Method Summary

Modifier and Type	Method and Description
void	cancelPong(boolean cancel) Prevents the PacketStatusOutPong packet from being sent The PacketStatusOutPong packet closes the connection and must be cancelled to create animations
ServerInfoPacket	createNewPacket(PingReply reply) Creates a new ServerInfoPacket from a PingReply instance
PingReply	getReply() Returns the PingReply instance
boolean	isCancelled() Returns whether the event has been cancelled
boolean	isPongCancelled() Returns whether the PacketStatusOutPong packet has been cancelled
void	setCancelled(boolean cancel) Cancels the event

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PingEvent

public PingEvent(PingReply reply)

Created a new PingEvent instance

Parameters:

reply - The reply

Method Detail

getReply

public PingReply getReply()

Returns the PingReply instance

Returns:

The reply

setCancelled

public void setCancelled(boolean cancel)

Cancels the event

Parameters:

cancel - A boolean

cancelPong

public void cancelPong(boolean cancel)

Prevents the PacketStatusOutPong packet from being sent The PacketStatusOutPong packet closes the connection and must be cancelled to create animations

Parameters:

cancel - A boolean

isCancelled

public boolean isCancelled()

Returns whether the event has been cancelled

Returns:

A boolean

isPongCancelled

public boolean isPongCancelled()

Returns whether the PacketStatusOutPong packet has been cancelled

Returns:

A boolean

createNewPacket

public ServerInfoPacket createNewPacket(PingReply reply)

Creates a new ServerInfoPacket from a PingReply instance

Parameters:

reply - The reply

Returns:

A ServerInfoPacket instance