Subscriber.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.sub;

import java.util.Collection;
import java.util.Set;

import org.omg.dds.core.DDSObject;
import org.omg.dds.core.DomainEntity;
import org.omg.dds.core.StatusCondition;
import org.omg.dds.core.status.Status;
import org.omg.dds.domain.DomainParticipant;
import org.omg.dds.topic.TopicDescription;
import org.omg.dds.topic.TopicQos;

public interface Subscriber
extends DomainEntity<SubscriberListener, SubscriberQos>
{
    // --- Create (any) DataReader: ------------------------------------------

    public <TYPE> DataReader<TYPE> createDataReader(
            TopicDescription<TYPE> topic);

    public <TYPE> DataReader<TYPE> createDataReader(
            TopicDescription<TYPE> topic,
            DataReaderQos qos,
            DataReaderListener<TYPE> listener,
            Collection<Class<? extends Status>> statuses);

    public <TYPE> DataReader<TYPE> createDataReader(
            TopicDescription<TYPE> topic,
            DataReaderQos qos,
            DataReaderListener<TYPE> listener,
            Class<? extends Status>... statuses);

    public <TYPE> DataReader<TYPE> createDataReader(
            TopicDescription<TYPE> topic,
            DataReaderQos qos);

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

    public <TYPE> DataReader<TYPE> lookupDataReader(String topicName);

    public <TYPE> DataReader<TYPE> lookupDataReader(
            TopicDescription<TYPE> topicName);


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

    public void closeContainedEntities();

    public Collection<DataReader<?>> getDataReaders();

    public Collection<DataReader<?>> getDataReaders(DataState dataState);

    public void notifyDataReaders();

    public void beginAccess();

    public void endAccess();

    public DataReaderQos getDefaultDataReaderQos();

    public void setDefaultDataReaderQos(DataReaderQos qos);

    public DataReaderQos copyFromTopicQos(DataReaderQos drQos, TopicQos tQos);


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

    @Override
    public DomainParticipant getParent();


    // --- DataState: ------------------------------------------------------

    public DataState createDataState();


    public static interface DataState extends DDSObject, Cloneable {
        // --- Accessors: ----------------------------------------------------

        public Set<SampleState> getSampleStates();

        public Set<ViewState> getViewStates();

        public Set<InstanceState> getInstanceStates();


        // --- Mutators: -----------------------------------------------------

        public DataState with(SampleState state);

        public DataState with(ViewState state);

        public DataState with(InstanceState state);

        public DataState withAnySampleState();

        public DataState withAnyViewState();

        public DataState withAnyInstanceState();

        public DataState withNotAliveInstanceStates();


        // --- From Object: --------------------------------------------------

        public DataState clone();

        public boolean equals(Object other);

        public int hashCode();
    }
}