Publisher.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.pub;

import java.util.Collection;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

import org.omg.dds.core.DomainEntity;
import org.omg.dds.core.Duration;
import org.omg.dds.core.StatusCondition;
import org.omg.dds.core.status.Status;
import org.omg.dds.domain.DomainParticipant;
import org.omg.dds.topic.Topic;
import org.omg.dds.topic.TopicQos;

public interface Publisher
extends DomainEntity<PublisherListener, PublisherQos>
{
    // --- Create (any) DataWriter: ------------------------------------------

    public <TYPE> DataWriter<TYPE> createDataWriter(
            Topic<TYPE> topic);

    public <TYPE> DataWriter<TYPE> createDataWriter(
            Topic<TYPE> topic,
            DataWriterQos qos,
            DataWriterListener<TYPE> listener,
            Collection<Class<? extends Status>> statuses);

    public <TYPE> DataWriter<TYPE> createDataWriter(
            Topic<TYPE> topic,
            DataWriterQos qos,
            DataWriterListener<TYPE> listener,
            Class<? extends Status>... statuses);

    public <TYPE> DataWriter<TYPE> createDataWriter(
            Topic<TYPE> topic,
            DataWriterQos qos);

    // --- Lookup operations: ------------------------------------------------

    public <TYPE> DataWriter<TYPE> lookupDataWriter(String topicName);

    public <TYPE> DataWriter<TYPE> lookupDataWriter(Topic<TYPE> topic);

    // --- Other operations: -------------------------------------------------

    public void closeContainedEntities();

    public void suspendPublications();

    public void resumePublications();

    public void beginCoherentChanges();

    public void endCoherentChanges();

    public void waitForAcknowledgments(Duration maxWait)
            throws TimeoutException;

    public void waitForAcknowledgments(long maxWait, TimeUnit unit)
            throws TimeoutException;

    public DataWriterQos getDefaultDataWriterQos();

    public void setDefaultDataWriterQos(DataWriterQos qos);

    public DataWriterQos copyFromTopicQos(DataWriterQos dwQos, TopicQos tQos);


    // --- From Entity: ------------------------------------------------------
    @Override
    public StatusCondition<Publisher> getStatusCondition();

    @Override
    public DomainParticipant getParent();
}