org.jboss.remoting3.RemotingOptions Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright 2010, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.remoting3;
import org.xnio.Option;
/**
* Common options for Remoting configuration.
*/
public final class RemotingOptions {
private RemotingOptions() {
}
/**
* The size of the largest buffer that this endpoint will transmit over a connection.
*/
public static final Option SEND_BUFFER_SIZE = Option.simple(RemotingOptions.class, "SEND_BUFFER_SIZE", Integer.class);
/**
* The default send buffer size.
*/
public static final int DEFAULT_SEND_BUFFER_SIZE = 8192;
/**
* The size of the largest buffer that this endpoint will accept over a connection.
*/
public static final Option RECEIVE_BUFFER_SIZE = Option.simple(RemotingOptions.class, "RECEIVE_BUFFER_SIZE", Integer.class);
/**
* The default receive buffer size.
*/
public static final int DEFAULT_RECEIVE_BUFFER_SIZE = 8192;
/**
* The size of allocated buffer regions.
*/
public static final Option BUFFER_REGION_SIZE = Option.simple(RemotingOptions.class, "BUFFER_REGION_SIZE", Integer.class);
/**
* The maximum window size of the transmit direction for connection channels, in bytes.
*/
public static final Option TRANSMIT_WINDOW_SIZE = Option.simple(RemotingOptions.class, "TRANSMIT_WINDOW_SIZE", Integer.class);
/**
* The default requested window size of the transmit direction for incoming channel open attempts.
*/
public static final int INCOMING_CHANNEL_DEFAULT_TRANSMIT_WINDOW_SIZE = 0x20000;
/**
* The default requested window size of the transmit direction for outgoing channel open attempts.
*/
public static final int OUTGOING_CHANNEL_DEFAULT_TRANSMIT_WINDOW_SIZE = Integer.MAX_VALUE;
/**
* The maximum window size of the receive direction for connection channels, in bytes.
*/
public static final Option RECEIVE_WINDOW_SIZE = Option.simple(RemotingOptions.class, "RECEIVE_WINDOW_SIZE", Integer.class);
/**
* The default requested window size of the receive direction for incoming channel open attempts.
*/
public static final int INCOMING_CHANNEL_DEFAULT_RECEIVE_WINDOW_SIZE = 0x20000;
/**
* The default requested window size of the receive direction for outgoing channel open attempts.
*/
public static final int OUTGOING_CHANNEL_DEFAULT_RECEIVE_WINDOW_SIZE = 0x20000;
/**
* The maximum number of outbound channels to support for a connection.
*/
public static final Option MAX_OUTBOUND_CHANNELS = Option.simple(RemotingOptions.class, "MAX_OUTBOUND_CHANNELS", Integer.class);
/**
* The default maximum number of outbound channels.
*/
public static final int DEFAULT_MAX_OUTBOUND_CHANNELS = 40;
/**
* The maximum number of inbound channels to support for a connection.
*/
public static final Option MAX_INBOUND_CHANNELS = Option.simple(RemotingOptions.class, "MAX_INBOUND_CHANNELS", Integer.class);
/**
* The default maximum number of inbound channels.
*/
public static final int DEFAULT_MAX_INBOUND_CHANNELS = 40;
/**
* The SASL authorization ID. Used as authentication user name to use if no authentication {@code CallbackHandler} is specified
* and the selected SASL mechanism demands a user name.
*/
public static final Option AUTHORIZE_ID = Option.simple(RemotingOptions.class, "AUTHORIZE_ID", String.class);
/**
* Deprecated alias for {@link #AUTHORIZE_ID}.
*/
@Deprecated
public static final Option AUTH_USER_NAME = AUTHORIZE_ID;
/**
* The authentication realm to use if no authentication {@code CallbackHandler} is specified.
*/
public static final Option AUTH_REALM = Option.simple(RemotingOptions.class, "AUTH_REALM", String.class);
/**
* Specify the number of times a client is allowed to retry authentication before closing the connection.
*/
public static final Option AUTHENTICATION_RETRIES = Option.simple(RemotingOptions.class, "AUTHENTICATION_RETRIES", Integer.class);
/**
* The default number of authentication retries.
*/
public static final int DEFAULT_AUTHENTICATION_RETRIES = 3;
/**
* The maximum number of concurrent outbound messages on a channel.
*/
public static final Option MAX_OUTBOUND_MESSAGES = Option.simple(RemotingOptions.class, "MAX_OUTBOUND_MESSAGES", Integer.class);
/**
* The default maximum number of concurrent outbound messages on an incoming channel.
*/
public static final int INCOMING_CHANNEL_DEFAULT_MAX_OUTBOUND_MESSAGES = 80;
/**
* The default maximum number of concurrent outbound messages on an outgoing channel.
*/
public static final int OUTGOING_CHANNEL_DEFAULT_MAX_OUTBOUND_MESSAGES = 0xffff;
/**
* The maximum number of concurrent inbound messages on a channel.
*/
public static final Option MAX_INBOUND_MESSAGES = Option.simple(RemotingOptions.class, "MAX_INBOUND_MESSAGES", Integer.class);
/**
* The default maximum number of concurrent inbound messages on a channel.
*/
public static final int DEFAULT_MAX_INBOUND_MESSAGES = 80;
/**
* The interval to use for connection heartbeat, in milliseconds. If the connection is idle in the outbound direction
* for this amount of time, a ping message will be sent, which will trigger a corresponding reply message.
*/
public static final Option HEARTBEAT_INTERVAL = Option.simple(RemotingOptions.class, "HEARTBEAT_INTERVAL", Integer.class);
/**
* The default heartbeat interval.
*/
public static final int DEFAULT_HEARTBEAT_INTERVAL = Integer.MAX_VALUE;
/**
* The maximum inbound message size to be allowed. Messages exceeding this size will cause an exception to be thrown
* on the reading side as well as the writing side.
*/
public static final Option MAX_INBOUND_MESSAGE_SIZE = Option.simple(RemotingOptions.class, "MAX_INBOUND_MESSAGE_SIZE", Long.class);
/**
* The default maximum inbound message size.
*/
public static final long DEFAULT_MAX_INBOUND_MESSAGE_SIZE = Long.MAX_VALUE;
/**
* The maximum outbound message size to send. No messages larger than this well be transmitted; attempting to do
* so will cause an exception on the writing side.
*/
public static final Option MAX_OUTBOUND_MESSAGE_SIZE = Option.simple(RemotingOptions.class, "MAX_OUTBOUND_MESSAGE_SIZE", Long.class);
/**
* The default maximum outbound message size.
*/
public static final long DEFAULT_MAX_OUTBOUND_MESSAGE_SIZE = Long.MAX_VALUE;
/**
* The server side of the connection passes it's name to the client in the initial greeting, by default the name is
* automatically discovered from the local address of the connection or it can be overridden using this {@code Option}.
*/
public static final Option SERVER_NAME = Option.simple(RemotingOptions.class, "SERVER_NAME", String.class);
/**
* Where a {@code SaslServer} or {@code SaslClient} are created by default the protocol specified it 'remoting', this
* {@code Option} can be used to override this.
*/
public static final Option SASL_PROTOCOL = Option.simple(RemotingOptions.class, "SASL_PROTOCOL", String.class);
/**
* The default SASL protocol name.
*/
public static final String DEFAULT_SASL_PROTOCOL = "remoting";
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy