com.nhn.gameanvil.node.support

Class BaseSpot

java.lang.Object

com.nhn.gameanvil.node.BaseObject

com.nhn.gameanvil.node.support.BaseSpot

All Implemented Interfaces:

MessageReplier, MessageDispatcher.MessageDispatchable, RestMessageDispatcher.RestMessageDispatchable, com.nhn.gameanvilcore.topic.TopicHelper

public abstract class BaseSpot
extends BaseObject
implements com.nhn.gameanvilcore.topic.TopicHelper, MessageDispatcher.MessageDispatchable, MessageReplier, RestMessageDispatcher.RestMessageDispatchable

스팟의 기본 구조를 가지고 있는 추상 클래스

콘텐츠에서 방을 사용하기위해서는 해당 클래스를 확장해서 사용해야 한다

Constructor Summary

Constructors

Constructor and Description
BaseSpot()

Method Summary

Modifier and Type	Method and Description
Timer	addTimer(int interval, java.util.concurrent.TimeUnit timeUnit, int times, TimerHandler handler, java.lang.Object obj, boolean isTickFromRun) 주기적으로 작업을 수행할 타이머를 추가 후 반환 받고 타이머 호출 반복 주기 방식도 설정한다
boolean	addTopic(java.lang.String topic) 토픽을 구독한다
boolean	addTopics(java.util.List<java.lang.String> topics) 여러 개의 토픽을 구독한다
BaseSupportNode	getBaseGameNode() 설정한 BaseSupportNode 객체를 가져온다
int	getGameId() 게임 아이디를 가져온다
int	getId() 그룹 아이디를 가져온다
java.util.Set<java.lang.String>	getTopics() 구독중인 토픽 목록을 가져온다
boolean	hasTopic(java.lang.String topic) 토픽이 구독 상태인지 확인한다
void	init(com.nhn.gameanvilcore.node.PacketGroupHelper packetGroupHelper) Deprecated.
abstract void	onDestroy() 객체가 소멸할 때 호출
void	onDispatch(Packet packet) 처리할 패킷이 전달될 때 호출
boolean	onDispatch(RestObject restObject) Rest API 호출시 호출
abstract boolean	onInit() 초기화 할때 호출
abstract void	onPause() 스팟이 붙어있던 노드가 Pause 될때에 호출
abstract void	onResume() 스팟이 붙어있던 노드가 Resume 될때에 호출
void	onTransferIn(TransferPack transferPack) 스팟이 이동(전송) 되어 다른 노드에 붙게 될 시에 호출되는 콜백
void	onTransferOut(TransferPack transferPack) 스팟이 붙어있던 노드의 TransferOut 호출시에 호출
void	postJob(com.nhn.gameanvilcore.node.PostHandler handler, java.lang.Object arg) 현재 진행되는 흐름 종료 후 다음번에 호출될 PostHandler를 지정한다
void	removeAllTimer() 추가된 모든 타이머를 제거한다
void	removeTimer(Timer timerObject) 주기적으로 작업을 수행하는 타이머를 제거한다
void	removeTopic(java.lang.String topic) 구독중인 토픽을 제거한다
void	removeTopics(java.util.List<java.lang.String> topics) 여러 개의 토픽을 구독 취소한다
void	reply(Packet packet) 전송된 Request 메시지에 대해 응답 한다
void	setBaseSupportNode(BaseSupportNode baseSupportNode) BaseSupportNode 를 설정한다

Methods inherited from class com.nhn.gameanvil.node.BaseObject

findAllUserLocsOfAccount, findOnlineUsers, findUserLoc, findUserLoc, findUsersLoc, getAllChannelList, getFirstNodeId, getFirstNodeId, getIntercom, getNodeId, getReadyAllGameNode, getReadyAllGameNode, getReadyAllSupportNode, getServiceId, getServiceName, init, publishToClient, publishToClient, publishToNode, publishToNode, publishToNodeWithChannelId, publishToNodeWithChannelId, publishToNodeWithHostId, publishToNodeWithHostId, publishToNodeWithNodeId, publishToNodeWithNodeId, publishToNodeWithServiceId, publishToNodeWithServiceId, publishToNodeWithServiceName, publishToNodeWithServiceName, publishToRoom, publishToRoom, publishToRoomWithChannelId, publishToRoomWithChannelId, publishToRoomWithHostId, publishToRoomWithHostId, publishToRoomWithNodeId, publishToRoomWithNodeId, publishToRoomWithServiceId, publishToRoomWithServiceId, publishToRoomWithServiceName, publishToRoomWithServiceName, publishToSpot, publishToSpot, publishToSpotWithHostId, publishToSpotWithHostId, publishToSpotWithNodeId, publishToSpotWithNodeId, publishToSpotWithServiceId, publishToSpotWithServiceId, publishToSpotWithServiceName, publishToSpotWithServiceName, publishToUser, publishToUser, publishToUserWithChannelId, publishToUserWithChannelId, publishToUserWithHostId, publishToUserWithHostId, publishToUserWithNodeId, publishToUserWithNodeId, publishToUserWithServiceId, publishToUserWithServiceId, publishToUserWithServiceName, publishToUserWithServiceName, requestAllChannelCountInfo, requestAllChannelInfo, requestAllGameNodeIds, requestAllUserIds, requestChannelCountInfo, requestChannelInfo, requestGameNodeId, requestOnlineCheck, requestToAllGameNode, requestToAllGameNode, requestToAllGameNode, requestToAllGameNode, requestToAllGameNode, requestToAllGameNode, requestToAllGameNode, requestToAllGameNode, requestToAllManagementNode, requestToAllManagementNode, requestToAllSession, requestToAllSession, requestToAllSupportNode, requestToAllSupportNode, requestToAllSupportNode, requestToAllSupportNode, requestToFirstNode, requestToFirstNode, requestToFirstNode, requestToFirstNode, requestToGameNode, requestToGameNode, requestToGameNode, requestToGameNode, requestToGameNode, requestToGameNode, requestToGameNode, requestToGameNode, requestToGatewayNode, requestToGatewayNode, requestToManagementNode, requestToManagementNode, requestToNode, requestToNode, requestToNodes, requestToNodes, requestToNodes, requestToRoom, requestToRoom, requestToRoom, requestToRoom, requestToSession, requestToSession, requestToSpot, requestToSpot, requestToSpot, requestToSpot, requestToSupportNode, requestToSupportNode, requestToSupportNode, requestToSupportNode, requestToUser, requestToUser, requestToUser, requestToUser, requestToUser, requestToUser, requestToUser, requestToUser, requestToUser, requestToUser, requestToUser, requestToUser, requestToUserInNode, requestToUserInNode, sendToClient, sendToClient, sendToClient, sendToClient, sendToClient, sendToClient, sendToClient, sendToClient, sendToFirstNode, sendToFirstNode, sendToFirstNode, sendToFirstNode, sendToGameNode, sendToGameNode, sendToGameNode, sendToGameNode, sendToGameNode, sendToGameNode, sendToGameNode, sendToGameNode, sendToManagementNode, sendToManagementNode, sendToNode, sendToNode, sendToRoom, sendToRoom, sendToRoom, sendToRoom, sendToSession, sendToSession, sendToSpot, sendToSpot, sendToSpot, sendToSpot, sendToSupportNode, sendToSupportNode, sendToSupportNode, sendToSupportNode, sendToUser, sendToUser, sendToUser, sendToUser, sendToUser, sendToUser, sendToUser, sendToUser, sendToUser, sendToUser, sendToUserInNode, sendToUserInNode, sendToUsers, sendToUsers, sendToUsers, sendToUsers

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.nhn.gameanvil.packet.message.MessageDispatcher.MessageDispatchable

getMessageDispatcher, onAfterDispatch, tryDispatch

Methods inherited from interface com.nhn.gameanvil.packet.message.extensions.MessageReplier

reply, reply

Methods inherited from interface com.nhn.gameanvil.packet.message.RestMessageDispatcher.RestMessageDispatchable

getRestMessageDispatcher, onAfterDispatchRest, tryRestDispatch

Constructor Detail

BaseSpot

public BaseSpot()

Method Detail

setBaseSupportNode

public void setBaseSupportNode(BaseSupportNode baseSupportNode)

BaseSupportNode 를 설정한다

Parameters:

baseSupportNode - 사용할 BaseSupportNode

getBaseGameNode

public BaseSupportNode getBaseGameNode()

설정한 BaseSupportNode 객체를 가져온다

Returns:

BaseSupportNode 반환

init

public final void init(com.nhn.gameanvilcore.node.PacketGroupHelper packetGroupHelper)

Deprecated.

사용 전 내부에 필요한 값 설정 및 초기화를 시켜준다

Parameters:

packetGroupHelper - 사용할 PacketGroupHelper

addTimer

public Timer addTimer(int interval,
                      java.util.concurrent.TimeUnit timeUnit,
                      int times,
                      TimerHandler handler,
                      java.lang.Object obj,
                      boolean isTickFromRun)

주기적으로 작업을 수행할 타이머를 추가 후 반환 받고 타이머 호출 반복 주기 방식도 설정한다

Parameters:

interval - 지연 간격

timeUnit - 시간 단위인 TimeUnit

times - 반복 횟수(0 == 무한반복)

handler - 등록할 핸들러인 TimerHandler

obj - 이벤트 발생시 핸들러에 넘겨줄 객체

isTickFromRun - false 이면 타이머는 가장 최근의 구동 시점 기준으로 인터벌후에 구동된다. true 이면 타이머는 등록 시점 기준으로 인터벌 주기로 반복된다

Returns:

Timer 타입으로 등록된 타이머 반환

removeTimer

public void removeTimer(Timer timerObject)

주기적으로 작업을 수행하는 타이머를 제거한다

Parameters:

timerObject - 제거할 타이머 객체인 Timer

removeAllTimer

public void removeAllTimer()

추가된 모든 타이머를 제거한다

getGameId

public int getGameId()

게임 아이디를 가져온다

Returns:

게임 아이디

getId

public int getId()

그룹 아이디를 가져온다

Returns:

그룹 아이디

reply

public void reply(Packet packet)

전송된 Request 메시지에 대해 응답 한다

Specified by:

reply in interface MessageReplier

Parameters:

packet - 전송할 Packet

postJob

public void postJob(com.nhn.gameanvilcore.node.PostHandler handler,
                    java.lang.Object arg)
             throws co.paralleluniverse.fibers.SuspendExecution,
                    GameAnvilException

현재 진행되는 흐름 종료 후 다음번에 호출될 PostHandler를 지정한다

Parameters:

handler - 호출될 핸들러인 PostHandler

arg - 핸들러에 전달된 파라미터인 Object

Throws:

co.paralleluniverse.fibers.SuspendExecution - 이 메서드는 파이버를 Suspend 할 수 있음을 의미

GameAnvilException - IOException, ExecutionException, InterruptedException 발생시 GameAnvilException 으로 묶어서 throw

hasTopic

public boolean hasTopic(java.lang.String topic)

토픽이 구독 상태인지 확인한다

Specified by:

hasTopic in interface com.nhn.gameanvilcore.topic.TopicHelper

Parameters:

topic - 확인할 토픽

Returns:

반환값이 true 이면 구독 중, false 이면 미구독

getTopics

public java.util.Set<java.lang.String> getTopics()

구독중인 토픽 목록을 가져온다

Specified by:

getTopics in interface com.nhn.gameanvilcore.topic.TopicHelper

Returns:

토픽 목록 반환

addTopic

public boolean addTopic(java.lang.String topic)

토픽을 구독한다

Specified by:

addTopic in interface com.nhn.gameanvilcore.topic.TopicHelper

Parameters:

topic - 구독할 토픽

Returns:

반환값이 true 이면 구독 성공, false 이면 실패

addTopics

public boolean addTopics(java.util.List<java.lang.String> topics)

여러 개의 토픽을 구독한다

Specified by:

addTopics in interface com.nhn.gameanvilcore.topic.TopicHelper

Parameters:

topics - 구독할 토픽 목록

Returns:

반환값이 true 이면 구독 성공, false 이면 구독 실패

removeTopic

public void removeTopic(java.lang.String topic)

구독중인 토픽을 제거한다

Specified by:

removeTopic in interface com.nhn.gameanvilcore.topic.TopicHelper

Parameters:

topic - 제거 토픽

removeTopics

public void removeTopics(java.util.List<java.lang.String> topics)

여러 개의 토픽을 구독 취소한다

Specified by:

removeTopics in interface com.nhn.gameanvilcore.topic.TopicHelper

Parameters:

topics - 구독 취소할 토픽 목록

onInit

public abstract boolean onInit()
                        throws co.paralleluniverse.fibers.SuspendExecution

초기화 할때 호출

Returns:

반환값이 true 이면 초기화 성공, false 이면 실패

Throws:

co.paralleluniverse.fibers.SuspendExecution - 이 메서드는 파이버를 Suspend 할 수 있음을 의미

onDestroy

public abstract void onDestroy()
                        throws co.paralleluniverse.fibers.SuspendExecution

객체가 소멸할 때 호출

Throws:

co.paralleluniverse.fibers.SuspendExecution - 이 메서드는 파이버를 Suspend 할 수 있음을 의미

onPause

public abstract void onPause()
                      throws co.paralleluniverse.fibers.SuspendExecution

스팟이 붙어있던 노드가 Pause 될때에 호출

Throws:

co.paralleluniverse.fibers.SuspendExecution - 이 메서드는 파이버를 Suspend 할 수 있음을 의미

onResume

public abstract void onResume()
                       throws co.paralleluniverse.fibers.SuspendExecution

스팟이 붙어있던 노드가 Resume 될때에 호출

Throws:

co.paralleluniverse.fibers.SuspendExecution - 이 메서드는 파이버를 Suspend 할 수 있음을 의미

onDispatch

public final void onDispatch(Packet packet)
                      throws co.paralleluniverse.fibers.SuspendExecution

처리할 패킷이 전달될 때 호출

Parameters:

packet - 처리될 Packet

Throws:

co.paralleluniverse.fibers.SuspendExecution - 이 메서드는 파이버를 Suspend 할 수 있음을 의미

onDispatch

public final boolean onDispatch(RestObject restObject)
                         throws co.paralleluniverse.fibers.SuspendExecution

Rest API 호출시 호출

Parameters:

restObject - 전달된 RestObject

Returns:

반환값이 true 이면 onDispatch 성공, false 이면 실패

Throws:

co.paralleluniverse.fibers.SuspendExecution - 이 메서드는 파이버를 Suspend 할 수 있음을 의미

onTransferOut

public void onTransferOut(TransferPack transferPack)
                   throws co.paralleluniverse.fibers.SuspendExecution

스팟이 붙어있던 노드의 TransferOut 호출시에 호출

Parameters:

transferPack - 다른 노드로 가지고 갈 데이터를 저장하기 위한 꾸러미인 TransferPack

Throws:

co.paralleluniverse.fibers.SuspendExecution - 이 메서드는 파이버를 Suspend 할 수 있음을 의미

onTransferIn

public void onTransferIn(TransferPack transferPack)
                  throws co.paralleluniverse.fibers.SuspendExecution

스팟이 이동(전송) 되어 다른 노드에 붙게 될 시에 호출되는 콜백

Parameters:

transferPack - 이동할때 다른 노드로 가지고 갈 데이터가 저장된 꾸러미인 TransferPack

Throws:

co.paralleluniverse.fibers.SuspendExecution - 이 메서드는 파이버를 Suspend 할 수 있음을 의미