Liveliness.java

Go to the documentation of this file.

/* Copyright 2010, Object Management Group, Inc.
 * Copyright 2010, PrismTech, Inc.
 * Copyright 2010, Real-Time Innovations, Inc.
 * 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.omg.dds.core.policy;

import java.util.concurrent.TimeUnit;

import org.omg.dds.core.Duration;


public interface Liveliness
extends QosPolicy.ForTopic,
        QosPolicy.ForDataReader,
        QosPolicy.ForDataWriter,
        RequestedOffered<Liveliness>
{
    // -----------------------------------------------------------------------
    // Methods
    // -----------------------------------------------------------------------

    public Kind getKind();

    public Duration getLeaseDuration();


    // --- Modification: -----------------------------------------------------

    public Liveliness withKind(Kind kind);

    public Liveliness withLeaseDuration(Duration leaseDuration);

    public Liveliness withLeaseDuration(
            long leaseDuration,
            TimeUnit unit);
    public Liveliness withAutomatic();
    public Liveliness withManualByParticipant();
    public Liveliness withManualByTopic();


    // -----------------------------------------------------------------------
    // Types
    // -----------------------------------------------------------------------

    public enum Kind {
        AUTOMATIC,

        MANUAL_BY_PARTICIPANT,

        MANUAL_BY_TOPIC
    }

}