reorder methods for maxOutgoingFrames, fix javadoc

Signed-off-by: Lachlan Roberts <lachlan@webtide.com>
This commit is contained in:
Lachlan Roberts 2020-09-10 09:50:52 +10:00
parent 4fd7920143
commit b44b62038c
2 changed files with 18 additions and 18 deletions

View File

@ -142,18 +142,7 @@ public interface RemoteEndpoint
void setBatchMode(BatchMode mode); void setBatchMode(BatchMode mode);
/** /**
* Set the maximum number of frames which allowed to be waiting to be sent at any one time. * Get the maximum number of data frames allowed to be waiting to be sent at any one time.
* The default value is -1, this indicates there is no limit on how many frames can be
* queued to be sent by the implementation. If the limit is exceeded, subsequent frames
* sent are failed with a {@link java.nio.channels.WritePendingException} but
* the connection is not failed and will remain open.
*
* @param maxOutgoingFrames the max number of frames.
*/
void setMaxOutgoingFrames(int maxOutgoingFrames);
/**
* Get the maximum number of frames which allowed to be waiting to be sent at any one time.
* The default value is -1, this indicates there is no limit on how many frames can be * The default value is -1, this indicates there is no limit on how many frames can be
* queued to be sent by the implementation. If the limit is exceeded, subsequent frames * queued to be sent by the implementation. If the limit is exceeded, subsequent frames
* sent are failed with a {@link java.nio.channels.WritePendingException} but * sent are failed with a {@link java.nio.channels.WritePendingException} but
@ -163,6 +152,17 @@ public interface RemoteEndpoint
*/ */
int getMaxOutgoingFrames(); int getMaxOutgoingFrames();
/**
* Set the maximum number of data frames allowed to be waiting to be sent at any one time.
* The default value is -1, this indicates there is no limit on how many frames can be
* queued to be sent by the implementation. If the limit is exceeded, subsequent frames
* sent are failed with a {@link java.nio.channels.WritePendingException} but
* the connection is not failed and will remain open.
*
* @param maxOutgoingFrames the max number of frames.
*/
void setMaxOutgoingFrames(int maxOutgoingFrames);
/** /**
* Get the InetSocketAddress for the established connection. * Get the InetSocketAddress for the established connection.
* *

View File

@ -455,18 +455,18 @@ public class WebSocketRemoteEndpoint implements RemoteEndpoint
this.batchMode = batchMode; this.batchMode = batchMode;
} }
@Override
public void setMaxOutgoingFrames(int maxOutgoingFrames)
{
this.maxNumOutgoingFrames = maxOutgoingFrames;
}
@Override @Override
public int getMaxOutgoingFrames() public int getMaxOutgoingFrames()
{ {
return maxNumOutgoingFrames; return maxNumOutgoingFrames;
} }
@Override
public void setMaxOutgoingFrames(int maxOutgoingFrames)
{
this.maxNumOutgoingFrames = maxOutgoingFrames;
}
@Override @Override
public void flush() throws IOException public void flush() throws IOException
{ {