/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.activemq.artemis.core.protocol.core;
import org.apache.activemq.artemis.core.security.ActiveMQPrincipal;
import org.apache.activemq.artemis.spi.core.protocol.RemotingConnection;
/**
* Extension of RemotingConnection for the ActiveMQ Artemis core protocol
*/
public interface CoreRemotingConnection extends RemotingConnection {
/**
* The client protocol used on the communication.
* This will determine if the client has support for certain packet types
*/
int getClientVersion();
/**
* Sets the client protocol used on the communication. This will determine if the client has
* support for certain packet types
*/
void setClientVersion(int clientVersion);
/**
* Returns the channel with the channel id specified.
* <p>
* If it does not exist create it with the confirmation window size.
*
* @param channelID the channel id
* @param confWindowSize the confirmation window size
* @return the channel
*/
Channel getChannel(long channelID, int confWindowSize);
/**
* add the channel with the specified channel id
*
* @param channelID the channel id
* @param channel the channel
*/
void putChannel(long channelID, Channel channel);
/**
* remove the channel with the specified channel id
*
* @param channelID the channel id
* @return true if removed
*/
boolean removeChannel(long channelID);
/**
* generate a unique (within this connection) channel id
*
* @return the id
*/
long generateChannelID();
/**
* Resets the id generator used to generate id's.
*
* @param id the first id to set it to
*/
void syncIDGeneratorSequence(long id);
/**
* Returns the next id to be chosen.
*
* @return the id
*/
long getIDGeneratorSequence();
/**
* Returns the current timeout for blocking calls
*
* @return the timeout in milliseconds
*/
long getBlockingCallTimeout();
/**
* Returns the current timeout for blocking calls
*
* @return the timeout in milliseconds
*/
long getBlockingCallFailoverTimeout();
/**
* Returns the transfer lock used when transferring connections.
*
* @return the lock
*/
Object getTransferLock();
/**
* Returns the default security principal
*
* @return the principal
*/
ActiveMQPrincipal getDefaultActiveMQPrincipal();
/**
*
* @param size size we are trying to write
* @param timeout
* @return
*/
boolean blockUntilWritable(int size, long timeout);
}