/*
 *                         OpenSplice DDS
 *
 *   This software and documentation are Copyright 2006 to TO_YEAR PrismTech
 *   Limited, its affiliated companies and licensors. All rights reserved.
 *
 *   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.opensplice.cm.qos;

import org.opensplice.cm.Time;

/**
 * Specifies the maximum acceptable delay from the time the data is written 
 * until the data is inserted in the receiver's application-cache and the 
 * receiving application is notified of the fact. This policy is a hint to the 
 * service, not something that must be monitored or enforced. The service is not 
 * required to track or alert the user of any violation.
 * 
 * @date Jan 10, 2005 
 */
public class LatencyPolicy {
    /**
     * Specifies the maximum acceptable delay from the time the data is written 
     * until the data is inserted in the receiver's application-cache and the 
     * receiving application is notified of the fact. This policy is a hint to 
     * the service, not something that must be monitored or enforced. The 
     * service is not required to track or alert the user of any violation. The 
     * default value of the duration is zero indicating that the delay should be
     * minimized.
     */
    public Time duration;
    
    public static final LatencyPolicy DEFAULT = new LatencyPolicy(Time.zero);
    
    /**
     * Constructs a new LatencyPolicy.
     *  
     *
     * @param _duration The duration.
     */
    public LatencyPolicy(Time _duration){
        duration = _duration;
    }
    
    public LatencyPolicy copy(){
        return new LatencyPolicy(this.duration.copy());
    }
}
