OpenSplice Java 5 DCPS  v6.x
OpenSplice Java 5 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
Entity.java
Go to the documentation of this file.
1 /* Copyright 2010, Object Management Group, Inc.
2  * Copyright 2010, PrismTech, Inc.
3  * Copyright 2010, Real-Time Innovations, Inc.
4  * All rights reserved.
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 
19 package org.omg.dds.core;
20 
21 import java.io.Closeable;
22 import java.util.Collection;
23 import java.util.EventListener;
24 import java.util.Set;
25 
26 import org.omg.dds.core.status.Status;
27 
28 
36 public interface Entity<LISTENER extends EventListener,
37  QOS extends EntityQos<?>>
38 extends Closeable, DDSObject
39 {
49  public LISTENER getListener();
50 
70  public void setListener(LISTENER listener);
71 
88  public void setListener(
89  LISTENER listener,
90  Collection<Class<? extends Status>> statuses);
91 
108  public void setListener(
109  LISTENER listener,
110  Class<? extends Status>... statuses);
111 
122  public QOS getQos();
123 
162  public void setQos(QOS qos);
163 
233  public void enable();
234 
242 
258  public Set<Class<? extends Status>> getStatusChanges();
259 
264 
297  @Override
298  public abstract void close();
299 
306  public void retain();
307 }
abstract void close()
Halt communication and dispose the resources held by this Entity.
InstanceHandle getInstanceHandle()
A StatusCondition object is an immutable object that specifies Condition that is associated with each...
void setQos(QOS qos)
This operation is used to set the QoS policies of the Entity.
void enable()
This operation enables the Entity.
An opaque handle that can be used to refer to a local or remote entity.
Set< Class<? extends Status > > getStatusChanges()
This operation retrieves the list of communication statuses in the Entity that are &#39;triggered...
This class is the abstract base class for all the DCPS objects that support QoS policies, a listener and a status condition.
Definition: Entity.java:36
A supertype of all DDS classes and interfaces.
Definition: DDSObject.java:25
QOS getQos()
This operation allows access to the existing set of QoS policies for the Entity.
LISTENER getListener()
This operation allows access to the existing Listener attached to the Entity.
StatusCondition<?> getStatusCondition()
This operation allows access to the org.omg.dds.core.StatusCondition associated with the Entity...
The Data-Distribution Service (DDS) relies on the use of QoS.
Definition: EntityQos.java:49
void retain()
Indicates that references to this object may go out of scope but that the application expects to look...
void setListener(LISTENER listener)
This operation installs a Listener on the Entity.
Status is the abstract root class for all communication status objects.
Definition: Status.java:41