Socks5ConnectionsRegistry.java

/*
 *  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.vysper.xmpp.extension.xep0065_socks;

import org.apache.mina.core.session.IoSession;

/**
 * A registry of currently active SOCKS5 session pairs. 
 * 
 * @author The Apache MINA Project (dev@mina.apache.org)
 */
public interface Socks5ConnectionsRegistry {
    
    /**
     * Register a {@link IoSession} as belonging to a pair identified by a hash.
     */
    Socks5Pair register(String hash, IoSession session);

    /**
     * Activate a session pair based on the hash
     */
    boolean activate(String hash);

    /**
     * Close a session pair based on the hash
     */
    void close(String hash);
}