tcpmessenger.java

High performance DB query

/*
 * @(#)$Id: TCPMessenger.java,v 1.6 2004/07/02 23:59:22 huebsch Exp $
 *
 * Copyright (c) 2001-2004 Regents of the University of California.
 * All rights reserved.
 *
 * This file is distributed under the terms in the attached BERKELEY-LICENSE
 * file. If you do not find these files, copies can be found by writing to:
 * Computer Science Division, Database Group, Universite of California,
 * 617 Soda Hall #1776, Berkeley, CA 94720-1776. Attention: Berkeley License
 *
 * Copyright (c) 2003-2004 Intel Corporation. All rights reserved.
 *
 * This file is distributed under the terms in the attached INTEL-LICENSE file.
 * If you do not find these files, copies can be found by writing to:
 * Intel Research Berkeley, 2150 Shattuck Avenue, Suite 1300,
 * Berkeley, CA, 94704.  Attention:  Intel License Inquiry.
 */


package services.network.tcp;

import java.net.InetSocketAddress;
import services.network.Payload;

/**
 * Interface TCPMessenger
 *
 */
public interface TCPMessenger {

    /**
     * Begin listening on a specific port
     *
     * @param portNumber
     * @param client
     * @return
     */
    public boolean listen(Integer portNumber, TCPClient client);

    /**
     * Stop listening on a specific port
     *
     * @param portNumber
     */
    public void release(Integer portNumber);

    /**
     * Create a TCP connection and begin the process of connecting,
     * involves sending data data. The connection can be used with
     * send immediately, although data will wait till connection is
     * established
     *
     * @param destination
     * @param client
     * @return
     */
    public TCPConnection connect(InetSocketAddress destination,
                                 TCPClient client);

    /**
     * Destroys the connection, making ineligible for future use
     *
     * @param connection
     */
    public void disconnect(TCPConnection connection);

    /**
     * Send data to the specified destination, linking return data to
     * this client.
     *
     *
     * @param destination
     * @param client
     * @param data
     * @return the connection that is created
     */
    public TCPConnection send(InetSocketAddress destination, TCPClient client,
                              Payload data);

    /**
     * Send data over the specified connection. If connection is not
     * connected, it is automatically reconnected.
     *
     * @param connection
     * @param data
     * @return true iff connection is valid (although maybe not open).
     */
    public boolean send(TCPConnection connection, Payload data);
}