MarkerListener.java

/*
 * Copyright 1999-2006 University of Chicago
 * 
 * Licensed 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.dcache.ftp.client;

/**
 * Represents an entity capable of receiving incoming markers.
 * Implement it to provide your own methods of analyzing markers.
 *
 * @see FTPClient#transfer(String, FTPClient, String, boolean, MarkerListener)
 * @see GridFTPClient#extendedTransfer(String, GridFTPClient, String, MarkerListener)
 **/
public interface MarkerListener
{

    /**
     * When writing your implementation, assume this method
     * being called whenever a marker arrives.
     **/
    void markerArrived(Marker m);

}