Package io.zenoh.pubsub
Class Publisher
-
- All Implemented Interfaces:
-
io.zenoh.session.SessionDeclaration
,java.lang.AutoCloseable
public final class Publisher implements SessionDeclaration, AutoCloseable
A Zenoh Publisher.
A publisher is automatically dropped when using it with the 'try-with-resources' statement (i.e. 'use' in Kotlin). The session from which it was declared will also keep a reference to it and undeclare it once the session is closed.
In order to declare a publisher, Session.declarePublisher must be called.
Example:
try (Session session = Session.open()) { try (KeyExpr keyExpr = KeyExpr.tryFrom("demo/java/greeting")) { System.out.println("Declaring publisher on '" + keyExpr + "'..."); try (Publisher publisher = session.declarePublisher(keyExpr)) { int i = 0; while (true) { publisher.put("Hello for the " + i + "th time!"); Thread.sleep(1000); i++; } } } } catch (ZError | InterruptedException e) { System.out.println("Error: " + e); }
The publisher configuration parameters can be later changed using the setter functions.
-
-
Method Summary
Modifier and Type Method Description final KeyExpr
getKeyExpr()
The key expression the publisher will be associated to. final Encoding
getEncoding()
The encoding user by the publisher. final CongestionControl
congestionControl()
Get the congestion control applied when routing the data. final Priority
priority()
Get the priority of the written data. final Unit
put(IntoZBytes payload)
Performs a PUT operation on the specified keyExpr with the specified payload. final Unit
put(IntoZBytes payload, PutOptions options)
Performs a PUT operation on the specified keyExpr with the specified payload. final Unit
put(String payload)
Performs a PUT operation on the specified keyExpr with the specified payload. final Unit
put(String payload, PutOptions options)
Performs a PUT operation on the specified keyExpr with the specified payload. final Unit
delete(DeleteOptions options)
Performs a DELETE operation on the specified keyExpr final Boolean
isValid()
Returns true
if the publisher is still running.Unit
close()
Unit
undeclare()
Undeclare a declaration. -
-
Method Detail
-
getKeyExpr
final KeyExpr getKeyExpr()
The key expression the publisher will be associated to.
-
getEncoding
final Encoding getEncoding()
The encoding user by the publisher.
-
congestionControl
final CongestionControl congestionControl()
Get the congestion control applied when routing the data.
-
put
final Unit put(IntoZBytes payload)
-
put
final Unit put(IntoZBytes payload, PutOptions options)
-
put
final Unit put(String payload, PutOptions options)
-
delete
final Unit delete(DeleteOptions options)
Performs a DELETE operation on the specified keyExpr
-
-
-
-