us.ihmc.pubsub.publisher.Publisher Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ihmc-pub-sub
IHMC Pub Sub
There is a newer version: 1.0.0
/**
 * Copyright 2024 Florida Institute for Human and Machine Cognition (IHMC)
 *
 * 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 us.ihmc.pubsub.publisher;

import java.io.IOException;

import us.ihmc.pubsub.attributes.PublisherAttributes;
import us.ihmc.pubsub.common.Guid;

/**
 * Class Publisher, used to send data to associated subscribers.
 *
 * @author Jesper Smith
 *
 */
public interface Publisher
{
   /**
    * Write data to the topic
    * 
    * This method does not allocate memory except when an exception is thrown
    * 
    * @param data
    * @throws IOException 
    */
   public void write(Object data) throws IOException;
   
   
   /**
    * Dispose of a previously written data
    * 
    * This method does not allocate memory except when an exception is thrown
    * 
    * @param data
    * @throws IOException
    */
   public void dispose(Object data) throws IOException;
   
   /**
    * Dispose of a previously written data
    * 
    * This method does not allocate memory except when an exception is thrown
    * 
    * @param data
    * @throws IOException
    */
   public void unregister(Object data) throws IOException;
   
   /**
    * Dispose and unregister a previously written data
    * 
    * This method does not allocate memory except when an exception is thrown
    * 
    * @param data
    * @throws IOException
    */
   public void dispose_and_unregister(Object data) throws IOException;
   
   /**
    * Remove all the Changes in the associated RTPSWriter.
    * 
    * @return number of elements removed
    * @throws IOException if not all elements were removed
    */
   public int removeAllChange() throws IOException;
   
   
   /**
    * This method does not allocate memory
    * 
    * @return the GUID_t of the associated RTPSWriter.
    */
   public Guid getGuid();
   
   /**
    * This method does not allocate memory
    * 
    * 
    * 
    * @return the Attributes of the Publisher
    */
   public PublisherAttributes getAttributes();
   
   
   /**
    * Checks if this publisher is available to write data to the domain 
    * 
    * This method does not allocate memory
    * 
    * @return true if this publisher is available
    */
   public boolean isAvailable();

   /** @return If the publisher has been destroyed/deleted/removed. */
   public boolean isRemoved();

   /** @return Total number of publications for statistic collection. */
   public long getNumberOfPublications();

   /** @return Latest published message payload for statistic collection. */
   public long getCurrentMessageSize();

   /** @return Largest ever published message payload for statistic collection. */
   public long getLargestMessageSize();

   /** @return Total payload bytes over all publications for statistic collection and bandwidth calculation. */
   public long getCumulativePayloadBytes();
}