DomainParticipant.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.domain;

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

import org.omg.dds.core.Duration;
import org.omg.dds.core.Entity;
import org.omg.dds.core.InstanceHandle;
import org.omg.dds.core.ModifiableTime;
import org.omg.dds.core.StatusCondition;
import org.omg.dds.core.Time;
import org.omg.dds.core.status.Status;
import org.omg.dds.pub.Publisher;
import org.omg.dds.pub.PublisherListener;
import org.omg.dds.pub.PublisherQos;
import org.omg.dds.sub.Subscriber;
import org.omg.dds.sub.SubscriberListener;
import org.omg.dds.sub.SubscriberQos;
import org.omg.dds.topic.ContentFilteredTopic;
import org.omg.dds.topic.MultiTopic;
import org.omg.dds.topic.ParticipantBuiltinTopicData;
import org.omg.dds.topic.Topic;
import org.omg.dds.topic.TopicBuiltinTopicData;
import org.omg.dds.topic.TopicDescription;
import org.omg.dds.topic.TopicListener;
import org.omg.dds.topic.TopicQos;
import org.omg.dds.type.TypeSupport;
import org.omg.dds.type.dynamic.DynamicType;



public interface DomainParticipant
extends Entity<DomainParticipantListener, DomainParticipantQos>
{
    // --- Create Publisher: -------------------------------------------------

    public Publisher createPublisher();

    public Publisher createPublisher(PublisherQos qos);

    public Publisher createPublisher(
            PublisherQos qos,
            PublisherListener listener,
            Collection<Class<? extends Status>> statuses);

    public Publisher createPublisher(
            PublisherQos qos,
            PublisherListener listener,
            Class<? extends Status>... statuses);

    // --- Create Subscriber: ------------------------------------------------

    public Subscriber createSubscriber();

    public Subscriber createSubscriber(SubscriberQos qos);

    public Subscriber createSubscriber(
            SubscriberQos qos,
            SubscriberListener listener,
            Collection<Class<? extends Status>> statuses);

    public Subscriber createSubscriber(
            SubscriberQos qos,
            SubscriberListener listener,
            Class<? extends Status>... statuses);

    public Subscriber getBuiltinSubscriber();


    // --- Create Topic with implicit TypeSupport: ---------------------------

    public <TYPE> Topic<TYPE> createTopic(
            String topicName,
            Class<TYPE> type);

    public <TYPE> Topic<TYPE> createTopic(
            String topicName,
            Class<TYPE> type,
            TopicQos qos,
            TopicListener<TYPE> listener,
            Collection<Class<? extends Status>> statuses);

    public <TYPE> Topic<TYPE> createTopic(
            String topicName,
            Class<TYPE> type,
            TopicQos qos,
            TopicListener<TYPE> listener,
            Class<? extends Status>... statuses);

    // --- Create Topic with explicit TypeSupport: ---------------------------

    public <TYPE> Topic<TYPE> createTopic(
            String topicName,
            TypeSupport<TYPE> type);

    public <TYPE> Topic<TYPE> createTopic(
            String topicName,
            TypeSupport<TYPE> type,
            TopicQos qos,
            TopicListener<TYPE> listener,
            Collection<Class<? extends Status>> statuses);

    public <TYPE> Topic<TYPE> createTopic(
            String topicName,
            TypeSupport<TYPE> type,
            TopicQos qos,
            TopicListener<TYPE> listener,
            Class<? extends Status>... statuses);

    // --- Create Topic with implicit TypeSupport: ---------------------------

    public Topic<DynamicType> createTopic(
            String topicName,
            DynamicType type);

    public Topic<DynamicType> createTopic(
            String topicName,
            DynamicType type,
            TopicQos qos,
            TopicListener<DynamicType> listener,
            Collection<Class<? extends Status>> statuses);

    public Topic<DynamicType> createTopic(
            String topicName,
            DynamicType type,
            TopicQos qos,
            TopicListener<DynamicType> listener,
            Class<? extends Status>... statuses);

    // --- Create Topic with explicit TypeSupport: ---------------------------

    public Topic<DynamicType> createTopic(
            String topicName,
            DynamicType type,
            TypeSupport<DynamicType> typeSupport);

    public Topic<DynamicType>createTopic(
            String topicName,
            DynamicType type,
            TypeSupport<DynamicType> typeSupport,
            TopicQos qos,
            TopicListener<DynamicType> listener,
            Collection<Class<? extends Status>> statuses);

    public Topic<DynamicType>createTopic(
            String topicName,
            DynamicType type,
            TypeSupport<DynamicType> typeSupport,
            TopicQos qos,
            TopicListener<DynamicType> listener,
            Class<? extends Status>... statuses);


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

    public <TYPE> Topic<TYPE> findTopic(
            String topicName,
            Duration timeout) throws TimeoutException;

    public <TYPE> Topic<TYPE> findTopic(
            String topicName,
            long timeout,
            TimeUnit unit)
            throws TimeoutException;

    public <TYPE> TopicDescription<TYPE> lookupTopicDescription(String name);

    public <TYPE> ContentFilteredTopic<TYPE> createContentFilteredTopic(
            String name,
            Topic<? extends TYPE> relatedTopic,
            String filterExpression,
            List<String> expressionParameters);

    public <TYPE> ContentFilteredTopic<TYPE> createContentFilteredTopic(
            String name,
            Topic<? extends TYPE> relatedTopic,
            String filterExpression,
            String... expressionParameters);

    public <TYPE> MultiTopic<TYPE> createMultiTopic(
            String name,
            Class<TYPE> type,
            String subscriptionExpression,
            List<String> expressionParameters);

    public <TYPE> MultiTopic<TYPE> createMultiTopic(
            String name,
            Class<TYPE> type,
            String subscriptionExpression,
            String... expressionParameters);

    public <TYPE> MultiTopic<TYPE> createMultiTopic(
            String name,
            TypeSupport<TYPE> type,
            String subscriptionExpression,
            List<String> expressionParameters);

    public <TYPE> MultiTopic<TYPE> createMultiTopic(
            String name,
            TypeSupport<TYPE> type,
            String subscriptionExpression,
            String... expressionParameters);

    public void closeContainedEntities();

    public void ignoreParticipant(InstanceHandle handle);

    public void ignoreTopic(InstanceHandle handle);

    public void ignorePublication(InstanceHandle handle);

    public void ignoreSubscription(InstanceHandle handle);

    public int getDomainId();

    public void assertLiveliness();

    public PublisherQos getDefaultPublisherQos();

    public void setDefaultPublisherQos(PublisherQos qos);

    public SubscriberQos getDefaultSubscriberQos();

    public void setDefaultSubscriberQos(SubscriberQos qos);

    public TopicQos getDefaultTopicQos();

    public void setDefaultTopicQos(TopicQos qos);

    public Set<InstanceHandle> getDiscoveredParticipants();

    public ParticipantBuiltinTopicData getDiscoveredParticipantData(
            InstanceHandle participantHandle);

    public Set<InstanceHandle> getDiscoveredTopics();

    public TopicBuiltinTopicData getDiscoveredTopicData(
            InstanceHandle topicHandle);

    public boolean containsEntity(InstanceHandle handle);

    public ModifiableTime getCurrentTime(ModifiableTime currentTime);

    public Time getCurrentTime();


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