Package com.neovisionaries.ws.client

Class PeriodicalFrameSender

java.lang.Object

com.neovisionaries.ws.client.PeriodicalFrameSender

Direct Known Subclasses:

PingSender, PongSender

abstract class PeriodicalFrameSender
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	PeriodicalFrameSender.Task

Field Summary

Fields

Modifier and Type	Field	Description
private PayloadGenerator	mGenerator
private long	mInterval
private boolean	mScheduled
private java.util.Timer	mTimer
private java.lang.String	mTimerName
private WebSocket	mWebSocket

Constructor Summary

Constructors

Constructor	Description
PeriodicalFrameSender(WebSocket webSocket, java.lang.String timerName, PayloadGenerator generator)

Method Summary

Modifier and Type	Method	Description
private WebSocketFrame	createFrame()
protected abstract WebSocketFrame	createFrame(byte[] payload)
private void	doTask()
private byte[]	generatePayload()
long	getInterval()
PayloadGenerator	getPayloadGenerator()
java.lang.String	getTimerName()
private static boolean	schedule(java.util.Timer timer, PeriodicalFrameSender.Task task, long interval)
void	setInterval(long interval)
void	setPayloadGenerator(PayloadGenerator generator)
void	setTimerName(java.lang.String timerName)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Field Detail

mWebSocket

private final WebSocket mWebSocket

mTimerName

private java.lang.String mTimerName

mTimer

private java.util.Timer mTimer

mScheduled

private boolean mScheduled

mInterval

private long mInterval

mGenerator

private PayloadGenerator mGenerator

Constructor Detail

PeriodicalFrameSender

public PeriodicalFrameSender(WebSocket webSocket,
                             java.lang.String timerName,
                             PayloadGenerator generator)

Method Detail

start

public void start()

stop

public void stop()

getInterval

public long getInterval()

setInterval

public void setInterval(long interval)

getPayloadGenerator

public PayloadGenerator getPayloadGenerator()

setPayloadGenerator

public void setPayloadGenerator(PayloadGenerator generator)

getTimerName

public java.lang.String getTimerName()

setTimerName

public void setTimerName(java.lang.String timerName)

doTask

private void doTask()

createFrame

private WebSocketFrame createFrame()

generatePayload

private byte[] generatePayload()

schedule

private static boolean schedule(java.util.Timer timer,
                                PeriodicalFrameSender.Task task,
                                long interval)

createFrame

protected abstract WebSocketFrame createFrame(byte[] payload)