Switch out exception with warning in Javadoc.

This commit is contained in:
Captain ALM 2023-05-21 01:11:07 +01:00
parent 100407dfc5
commit 6d096beb3f
Signed by: alfred
GPG Key ID: 4E4ADD02609997B1
2 changed files with 4 additions and 10 deletions

View File

@ -409,11 +409,9 @@ public class NetMarshalClient implements Closeable {
* @throws IOException A stream exception has occurred. * @throws IOException A stream exception has occurred.
* @throws PacketException An exception has occurred. * @throws PacketException An exception has occurred.
* @throws NullPointerException packetIn is null. * @throws NullPointerException packetIn is null.
* @throws IllegalStateException sendPacket accessed in the receive thread.
*/ */
public final void sendPacket(IPacket packetIn, boolean directSend) throws IOException, PacketException { public final void sendPacket(IPacket packetIn, boolean directSend) throws IOException, PacketException {
if (packetIn == null) throw new NullPointerException("packetIn is null"); if (packetIn == null) throw new NullPointerException("packetIn is null");
if (Thread.currentThread() == receiveThread) throw new IllegalStateException("sendPacket accessed in the receive thread");
synchronized (slocksock) { synchronized (slocksock) {
if (fragmentationOptions == null || directSend) { if (fragmentationOptions == null || directSend) {
loader.writePacket(outputStream, packetIn, true); loader.writePacket(outputStream, packetIn, true);
@ -428,10 +426,8 @@ public class NetMarshalClient implements Closeable {
* Flushes the output streams. * Flushes the output streams.
* *
* @throws IOException A stream exception has occurred. * @throws IOException A stream exception has occurred.
* @throws IllegalStateException flush accessed in the receive thread.
*/ */
public final void flush() throws IOException { public final void flush() throws IOException {
if (Thread.currentThread() == receiveThread) throw new IllegalStateException("sendPacket accessed in the receive thread");
synchronized (slocksock) { synchronized (slocksock) {
outputStream.flush(); outputStream.flush();
rootOutputStream.flush(); rootOutputStream.flush();
@ -558,7 +554,7 @@ public class NetMarshalClient implements Closeable {
/** /**
* Gets the {@link BiConsumer} receiver consumer. * Gets the {@link BiConsumer} receiver consumer.
* WARNING: {@link #sendPacket(IPacket, boolean)} and {@link #flush()} cannot be called within the consumer. * WARNING: Calling {@link #sendPacket(IPacket, boolean)} or {@link #flush()} could cause full buffer hangs.
* *
* @return The receiver consumer or null. * @return The receiver consumer or null.
*/ */
@ -568,7 +564,7 @@ public class NetMarshalClient implements Closeable {
/** /**
* Sets the {@link BiConsumer} receiver consumer. * Sets the {@link BiConsumer} receiver consumer.
* WARNING: {@link #sendPacket(IPacket, boolean)} and {@link #flush()} cannot be called within the consumer. * WARNING: Calling {@link #sendPacket(IPacket, boolean)} or {@link #flush()} could cause full buffer hangs.
* *
* @param consumer The new receiver consumer. * @param consumer The new receiver consumer.
* @throws NullPointerException consumer is null. * @throws NullPointerException consumer is null.

View File

@ -194,7 +194,6 @@ public class NetMarshalServer implements Closeable {
* @throws IOException A stream exception has occurred. * @throws IOException A stream exception has occurred.
* @throws PacketException An exception has occurred. * @throws PacketException An exception has occurred.
* @throws NullPointerException packetIn is null. * @throws NullPointerException packetIn is null.
* @throws IllegalStateException sendPacket accessed in the receive thread.
*/ */
public final void broadcastPacket(IPacket packetIn, boolean directSend) throws IOException, PacketException { public final void broadcastPacket(IPacket packetIn, boolean directSend) throws IOException, PacketException {
if (packetIn == null) throw new NullPointerException("packetIn is null"); if (packetIn == null) throw new NullPointerException("packetIn is null");
@ -208,7 +207,6 @@ public class NetMarshalServer implements Closeable {
* Flushes all the output streams on all the clients. * Flushes all the output streams on all the clients.
* *
* @throws IOException A stream exception has occurred. * @throws IOException A stream exception has occurred.
* @throws IllegalStateException flush accessed in the receive thread.
*/ */
public final void flush() throws IOException { public final void flush() throws IOException {
synchronized (slocksock) { synchronized (slocksock) {
@ -228,7 +226,7 @@ public class NetMarshalServer implements Closeable {
/** /**
* Gets the {@link BiConsumer} receiver consumer. * Gets the {@link BiConsumer} receiver consumer.
* WARNING: {@link #broadcastPacket(IPacket, boolean)} and {@link #flush()} cannot be called within the consumer. * WARNING: Calling {@link #broadcastPacket(IPacket, boolean)} or {@link #flush()} could cause full buffer hangs.
* *
* @return The receiver consumer or null. * @return The receiver consumer or null.
*/ */
@ -238,7 +236,7 @@ public class NetMarshalServer implements Closeable {
/** /**
* Sets the {@link BiConsumer} receiver consumer. * Sets the {@link BiConsumer} receiver consumer.
* WARNING: {@link #broadcastPacket(IPacket, boolean)} and {@link #flush()} cannot be called within the consumer. * WARNING: Calling {@link #broadcastPacket(IPacket, boolean)} or {@link #flush()} could cause full buffer hangs.
* *
* @param consumer The new receiver consumer. * @param consumer The new receiver consumer.
* @throws NullPointerException consumer is null. * @throws NullPointerException consumer is null.