com.whizzosoftware.hobson.api.plugin.channel

Class ChannelIdleDetectionConfig

java.lang.Object

com.whizzosoftware.hobson.api.plugin.channel.ChannelIdleDetectionConfig

public class ChannelIdleDetectionConfig
extends java.lang.Object

Configuration that defines a plugin's channel idle detection configuration.

Author:

Dan Noguerol

Constructor Summary

Constructors

Constructor and Description
ChannelIdleDetectionConfig(int maxIdleTime, java.lang.String heartbeatFrame) Constructor.

Method Summary

Modifier and Type	Method and Description
ByteBuf	getHeartbeatFrame() Returns the heartbeat frame that is sent when a channel is considered idle.
int	getMaxIdleTime() Returns the maximum number of seconds a channel can be idle before a heartbeat is sent.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelIdleDetectionConfig

public ChannelIdleDetectionConfig(int maxIdleTime,
                                  java.lang.String heartbeatFrame)

Constructor.

Parameters:

maxIdleTime - the maximum number of seconds a channel can be idle before a heartbeat is sent

heartbeatFrame - the heartbeat frame to send when a channel is considered idle

Method Detail

getMaxIdleTime

public int getMaxIdleTime()

Returns the maximum number of seconds a channel can be idle before a heartbeat is sent.

Returns:

an int

getHeartbeatFrame

public ByteBuf getHeartbeatFrame()

Returns the heartbeat frame that is sent when a channel is considered idle.

Returns:

a ByteBuf