Record Class ExternalSetting

java.lang.Object

java.lang.Record

com.iohao.net.external.core.ExternalSetting

Record Components:

port - port exposed to real players

server - server metadata descriptor

userSessions - user session manager

idleProcessSetting - heartbeat/idle processing settings

options - extensible attribute options

All Implemented Interfaces:

AttrOptionDynamic

public record ExternalSetting(int port, Server server, UserSessions<?,?> userSessions, IdleProcessSetting idleProcessSetting, AttrOptions options)
extends Record
implements AttrOptionDynamic

Immutable runtime settings for one external server instance.

Since:

25.1

Author:

渔民小镇

date:

2025-10-15

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExternalSetting.RecordBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final AttrOption<NetServerSetting>	netServerSetting	Attribute key storing the resolved NetServerSetting.

Constructor Summary

Constructors

Constructor	Description
ExternalSetting(int port, Server server, UserSessions<?,?> userSessions, IdleProcessSetting idleProcessSetting, AttrOptions options)	Creates an instance of a ExternalSetting record class.

Method Summary

Modifier and Type	Method	Description
static ExternalSetting.RecordBuilder	builder()
ConvenientCommunication	convenientCommunication()	Get the convenient communication facade from the attached net server setting.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
AttrOptions	getOptions()	Gets the dynamic member attributes (options)
final int	hashCode()	Returns a hash code value for this object.
IdleProcessSetting	idleProcessSetting()	Returns the value of the idleProcessSetting record component.
void	inject(Object o)	Inject this setting into supported aware components.
NetServerSetting	netServerSetting()	Get the net server setting attached to this external setting.
AttrOptions	options()	Returns the value of the options record component.
int	port()	Returns the value of the port record component.
Server	server()	Returns the value of the server record component.
final String	toString()	Returns a string representation of this record class.
UserSessions<?,?>	userSessions()	Returns the value of the userSessions record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface AttrOptionDynamic

ifNull, ifPresent, option, option, optionValue

Field Details

netServerSetting

public static final AttrOption<NetServerSetting> netServerSetting

Attribute key storing the resolved NetServerSetting.

Constructor Details

ExternalSetting

public ExternalSetting(int port,
 Server server,
 UserSessions<?,?> userSessions,
 IdleProcessSetting idleProcessSetting,
 AttrOptions options)

Creates an instance of a ExternalSetting record class.

Parameters:

port - the value for the port record component

server - the value for the server record component

userSessions - the value for the userSessions record component

idleProcessSetting - the value for the idleProcessSetting record component

options - the value for the options record component

Method Details

netServerSetting

public NetServerSetting netServerSetting()

Get the net server setting attached to this external setting.

Returns:

net server setting, or null if not attached

convenientCommunication

public ConvenientCommunication convenientCommunication()

Get the convenient communication facade from the attached net server setting.

Returns:

convenient communication facade

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

inject

public void inject(Object o)

Inject this setting into supported aware components.

Parameters:

o - target component

builder

public static ExternalSetting.RecordBuilder builder()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

port

public int port()

Returns the value of the port record component.

Returns:

the value of the port record component

server

public Server server()

Returns the value of the server record component.

Returns:

the value of the server record component

userSessions

public UserSessions<?,?> userSessions()

Returns the value of the userSessions record component.

Returns:

the value of the userSessions record component

idleProcessSetting

public IdleProcessSetting idleProcessSetting()

Returns the value of the idleProcessSetting record component.

Returns:

the value of the idleProcessSetting record component

options

public AttrOptions options()

Returns the value of the options record component.

Returns:

the value of the options record component