Package org.omegazero.net.common

Class NetCommon

java.lang.Object

org.omegazero.net.common.NetCommon

public final class NetCommon
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	PRINT_STACK_TRACES	System property org.omegazero.net.printStackTraces
static final boolean	SOCKET_ERROR_DEBUG	System property org.omegazero.net.socketErrorDebug
static final String	VERSION	The version string of omz-net-lib.

Constructor Summary

Constructors

Constructor	Description
NetCommon()

Method Summary

Modifier and Type	Method	Description
static String	getVersion()	Returns the version string.
static boolean	isPrintStackTraces()	Deprecated. Access PRINT_STACK_TRACES directly instead
static void	logSocketError(org.omegazero.common.logging.Logger logger, String msg, SocketConnection conn, Throwable e)

Methods inherited from class java.lang.Object

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

Field Details

VERSION

public static final String VERSION

The version string of omz-net-lib.

This value is set by the build CI pipeline based on the event that triggered the build. Otherwise, this string is always "$BUILDVERSION".

getVersion() should be used to retrieve the value to prevent compile-time string inlining.

See Also:

• Constant Field Values

PRINT_STACK_TRACES

public static final boolean PRINT_STACK_TRACES

System property org.omegazero.net.printStackTraces

Whether the full stack trace of a socket error should be printed instead of just the error message.

Default: false

SOCKET_ERROR_DEBUG

public static final boolean SOCKET_ERROR_DEBUG

System property org.omegazero.net.socketErrorDebug

Whether the default socket error handler should print socket error messages with log level DEBUG instead of WARN. This may be used to reduce log noise on public-facing servers where there may be many misbehaving clients connecting to it.

Default: false

Constructor Details

NetCommon

public NetCommon()

Method Details

isPrintStackTraces

@Deprecated
public static boolean isPrintStackTraces()

Deprecated.

Access PRINT_STACK_TRACES directly instead

logSocketError

public static void logSocketError(org.omegazero.common.logging.Logger logger,
 String msg,
 SocketConnection conn,
 Throwable e)

getVersion

public static String getVersion()

Returns the version string.

Returns:

The version string

Since:

2.1.0