Class ExternalServerBuilder

java.lang.Object

com.iohao.net.external.core.ExternalServerBuilder

All Implemented Interfaces:

AttrOptionDynamic, ExternalServerBuilderSetting

public final class ExternalServerBuilder
extends Object
implements ExternalServerBuilderSetting

Builder for assembling an external server and its runtime dependencies.

Since:

25.1

Author:

渔民小镇

date:

2023-02-19

Constructor Summary

Constructors

Constructor	Description
ExternalServerBuilder()

Method Summary

Modifier and Type	Method	Description
ExternalServer	build()	Build an ExternalServer with defaults, transport-specific settings, and injected dependencies.
ExternalServerCreator	getExternalServerCreator()
int	getId()	externalServerId
IdleProcessSettingBuilder	getIdleProcessSettingBuilder()	Heartbeat-related settings
ExternalJoinEnum	getJoinEnum()	Connection method: defaults to Websocket
MicroBootstrap	getMicroBootstrap()	Get the micro bootstrap instance.
MicroBootstrapFlow<?>	getMicroBootstrapFlow()	The startup process for the server that connects with real players
AttrOptions	getOptions()	Gets the dynamic member attributes (options)
int	getPort()
UserHook	getUserHook()	UserHook hook interface, triggered on login and logout
UserSessions<?,?>	getUserSessions()	User (player) session manager
void	setExternalServerCreator(ExternalServerCreator externalServerCreator)
void	setId(int id)	externalServerId
void	setIdleProcessSettingBuilder(IdleProcessSettingBuilder idleProcessSettingBuilder)	Heartbeat-related settings
void	setJoinEnum(ExternalJoinEnum joinEnum)	Connection method: defaults to Websocket
void	setMicroBootstrap(MicroBootstrap microBootstrap)	Set the micro bootstrap instance.
void	setMicroBootstrapFlow(MicroBootstrapFlow<?> microBootstrapFlow)	The startup process for the server that connects with real players
void	setPort(int port)
void	setUserHook(UserHook userHook)	UserHook hook interface, triggered on login and logout
void	setUserSessions(UserSessions<?,?> userSessions)	User (player) session manager

Methods inherited from class Object

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

Methods inherited from interface AttrOptionDynamic

ifNull, ifPresent, option, option, optionValue

Constructor Details

ExternalServerBuilder

public ExternalServerBuilder()

Method Details

build

public ExternalServer build()

Build an ExternalServer with defaults, transport-specific settings, and injected dependencies.

Returns:

configured external server instance

getOptions

public AttrOptions getOptions()

Description copied from interface: AttrOptionDynamic

Gets the dynamic member attributes (options)

Specified by:

getOptions in interface AttrOptionDynamic

Returns:

The dynamic member attributes

getId

public int getId()

externalServerId

getPort

public int getPort()

getJoinEnum

public ExternalJoinEnum getJoinEnum()

Connection method: defaults to Websocket

getMicroBootstrapFlow

public MicroBootstrapFlow<?> getMicroBootstrapFlow()

The startup process for the server that connects with real players

Specified by:

getMicroBootstrapFlow in interface ExternalServerBuilderSetting

Returns:

micro bootstrap flow

getIdleProcessSettingBuilder

public IdleProcessSettingBuilder getIdleProcessSettingBuilder()

Heartbeat-related settings

Specified by:

getIdleProcessSettingBuilder in interface ExternalServerBuilderSetting

Returns:

idle process setting builder

getUserSessions

public UserSessions<?,?> getUserSessions()

User (player) session manager

Specified by:

getUserSessions in interface ExternalServerBuilderSetting

Returns:

user session manager

getUserHook

public UserHook getUserHook()

UserHook hook interface, triggered on login and logout

getMicroBootstrap

public MicroBootstrap getMicroBootstrap()

Description copied from interface: ExternalServerBuilderSetting

Get the micro bootstrap instance.

Specified by:

getMicroBootstrap in interface ExternalServerBuilderSetting

Returns:

micro bootstrap

getExternalServerCreator

public ExternalServerCreator getExternalServerCreator()

setId

public void setId(int id)

externalServerId

setPort

public void setPort(int port)

setJoinEnum

public void setJoinEnum(ExternalJoinEnum joinEnum)

Connection method: defaults to Websocket

setMicroBootstrapFlow

public void setMicroBootstrapFlow(MicroBootstrapFlow<?> microBootstrapFlow)

The startup process for the server that connects with real players

Specified by:

setMicroBootstrapFlow in interface ExternalServerBuilderSetting

Parameters:

microBootstrapFlow - micro bootstrap flow

setIdleProcessSettingBuilder

public void setIdleProcessSettingBuilder(IdleProcessSettingBuilder idleProcessSettingBuilder)

Heartbeat-related settings

setUserSessions

public void setUserSessions(UserSessions<?,?> userSessions)

User (player) session manager

Specified by:

setUserSessions in interface ExternalServerBuilderSetting

Parameters:

userSessions - user session manager

setUserHook

public void setUserHook(UserHook userHook)

UserHook hook interface, triggered on login and logout

setMicroBootstrap

public void setMicroBootstrap(MicroBootstrap microBootstrap)

Description copied from interface: ExternalServerBuilderSetting

Set the micro bootstrap instance.

Specified by:

setMicroBootstrap in interface ExternalServerBuilderSetting

Parameters:

microBootstrap - micro bootstrap

setExternalServerCreator

public void setExternalServerCreator(ExternalServerCreator externalServerCreator)