Platform SDK Java 8.5 API Reference

com.genesyslab.platform.management.protocol.localcontrolagent.events
Class EventInitHeartbeats

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.management.protocol.localcontrolagent.events.EventInitHeartbeats
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventInitHeartbeats
extends Message

Internal event sent by LCA upon 'opened' channel to initialize the heartbeating functionality, if it is turned on in the application.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventInitHeartbeats create()
          Creates instance of EventInitHeartbeats with no parameters set.
static EventInitHeartbeats create(java.lang.Integer heartbeatPeriod, java.lang.Integer heartbeatPort)
          Creates instance of EventInitHeartbeats with all parameters set.
abstract  java.lang.Integer getHeartbeatPeriod()
           
abstract  java.lang.Integer getHeartbeatPort()
           
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  void setHeartbeatPeriod(int heartbeatPeriod)
           
abstract  void setHeartbeatPeriod(java.lang.Integer heartbeatPeriod)
           
abstract  void setHeartbeatPort(int heartbeatPort)
           
abstract  void setHeartbeatPort(java.lang.Integer heartbeatPort)
           
abstract  void setReferenceId(int referenceId)
          Reference identifier of the request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference identifier of the request.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.Message
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject
equals, hashCode, toString, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Method Detail

create

public static EventInitHeartbeats create()
Creates instance of EventInitHeartbeats with no parameters set.

Returns:
instance of EventInitHeartbeats

create

public static EventInitHeartbeats create(java.lang.Integer heartbeatPeriod,
                                         java.lang.Integer heartbeatPort)
Creates instance of EventInitHeartbeats with all parameters set.

Parameters:
heartbeatPeriod - HeartbeatPeriod
heartbeatPort - HeartbeatPort
Returns:
instance of EventInitHeartbeats

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(int referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


getHeartbeatPeriod

public abstract java.lang.Integer getHeartbeatPeriod()

setHeartbeatPeriod

public abstract void setHeartbeatPeriod(java.lang.Integer heartbeatPeriod)

setHeartbeatPeriod

public abstract void setHeartbeatPeriod(int heartbeatPeriod)

getHeartbeatPort

public abstract java.lang.Integer getHeartbeatPort()

setHeartbeatPort

public abstract void setHeartbeatPort(java.lang.Integer heartbeatPort)

setHeartbeatPort

public abstract void setHeartbeatPort(int heartbeatPort)

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.