org.itsnat.core.event

Interface ItsNatAttachedClientTimerEvent

All Superinterfaces:

ItsNatAttachedClientEvent, ItsNatEvent, ItsNatUserData

public interface ItsNatAttachedClientTimerEvent
extends ItsNatAttachedClientEvent

This event object is sent to registered ItsNatAttachedClientEventListener objects to notify the several phases of a remote control process using a timer to notify the client any document change.

Author:

Jose Maria Arranz Santamaria

Field Summary

Fields inherited from interface org.itsnat.core.event.ItsNatAttachedClientEvent

LOAD, REFRESH, REQUEST, UNLOAD

Method Summary

Methods

Modifier and Type	Method and Description
int	getRefreshInterval() Returns the refresh interval.

Methods inherited from interface org.itsnat.core.event.ItsNatAttachedClientEvent

getEventTimeout, getPhase, getWaitDocTimeout, isAccepted, isReadOnly, setAccepted

Methods inherited from interface org.itsnat.core.event.ItsNatEvent

getClientDocument, getCommMode, getExtraParam, getExtraParamMultiple, getItsNatDocument, getItsNatEventListenerChain, getItsNatServletRequest, getItsNatServletResponse, setExtraParam

Methods inherited from interface org.itsnat.core.ItsNatUserData

containsUserValueName, getUserValue, getUserValueNames, removeUserValue, setUserValue

Method Detail

getRefreshInterval

int getRefreshInterval()

Returns the refresh interval. If this event is a ItsNatAttachedClientEvent.REQUEST returned value may be used to validate the request.

Returned value is proposed initially by the client but can not change during the remote control life cycle. If a new remote control request was accepted use this value to verify if the accepted refresh interval is the same or lower than the real interval between events (to detect some kind of client manipulation and avoid a server overload).

Returns:

the refresh interval.

See Also:

ItsNatAttachedClientEvent.setAccepted(boolean)