Package org.apache.pulsar.client.api

Interface PulsarClientSharedResources

All Superinterfaces:

AutoCloseable

public interface PulsarClientSharedResources
extends AutoCloseable

Manages shared resources across multiple PulsarClient instances to optimize resource utilization. This interface provides access to common resources such as thread pools and DNS resolver/cache that can be shared between multiple PulsarClient instances. This allows creating a large number of PulsarClient instances in a single JVM without wasting resources. Sharing the DNS resolver and cache will help reduce the number of DNS lookups performed by the clients and improve latency and reduce load on the DNS servers.

Key features:

• Thread pool sharing for various Pulsar operations (IO, timer, lookup, etc.)
• Shared DNS resolver and cache
• Resource lifecycle management

Usage example:

 // To share all possible resources across multiple PulsarClient instances
 PulsarClientSharedResources sharedResources = PulsarClientSharedResources.builder()
     .build();
 // Use these resources with multiple PulsarClient instances
 PulsarClient client1 = PulsarClient.builder().sharedResources(sharedResources).build();
 PulsarClient client2 = PulsarClient.builder().sharedResources(sharedResources).build();
 client1.close();
 client2.close();
 sharedResources.close();
 

The instance should be created using the PulsarClientSharedResourcesBuilder, which can be obtained via the builder() method.

See Also:

• PulsarClientSharedResourcesBuilder
• PulsarClientSharedResources.SharedResource

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	PulsarClientSharedResources.SharedResource
static enum	PulsarClientSharedResources.SharedResourceType

Method Summary

Modifier and Type	Method	Description
static PulsarClientSharedResourcesBuilder	builder()	Creates a new builder for constructing instances of PulsarClientSharedResources.
void	close()	Closes this instance of PulsarClientSharedResources and releases all associated resources.
boolean	contains(PulsarClientSharedResources.SharedResource sharedResource)	Checks if a resource type is contained in the shared resources instance.
Set<PulsarClientSharedResources.SharedResource>	getSharedResources()	Gets all resource types contained in this shared resources instance.

Method Details

contains

boolean contains(PulsarClientSharedResources.SharedResource sharedResource)

Checks if a resource type is contained in the shared resources instance.

Parameters:

sharedResource - the type of resource to check

Returns:

true if the resource type is contained in this instance, false otherwise

getSharedResources

Set<PulsarClientSharedResources.SharedResource> getSharedResources()

Gets all resource types contained in this shared resources instance.

Returns:

set of resource types available in this instance

builder

static PulsarClientSharedResourcesBuilder builder()

Creates a new builder for constructing instances of PulsarClientSharedResources.

Returns:

a new PulsarClientSharedResourcesBuilder which can be used to configure and build shared resources for use across multiple PulsarClient instances.

close

void close()
    throws PulsarClientException

Closes this instance of PulsarClientSharedResources and releases all associated resources. All PulsarClient instances using these shared resources must be closed before calling this method.

Specified by:

close in interface AutoCloseable

Throws:

PulsarClientException - if there is an error while closing the shared resources