com.screenscraper.http.util

Interface SharedHttpClient

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

AsyncScrapingHttpClient2.SharedAsyncHttpClient, SharedHttpClientBase

public interface SharedHttpClient
extends java.lang.AutoCloseable

Class Description

Version:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	SHUTDOWN_USE_COUNT At how many uses should the real shutdown happen.

Method Summary

Modifier and Type	Method and Description
boolean	addUse() Attempts to mark a new use of this shared resources and returns whether or not the addition was successful
void	close()
java.util.Set<SharedResourceUser>	getCurrentUsers() Returns a set of the current users of the client.
int	getOpenCount() Returns the number of open uses of the client
boolean	isClosed() Returns whether or not this shared resource is closed.
void	registerUser(SharedResourceUser user) Registers a user of the resource.
void	removeUser(SharedResourceUser user) Registers a user of the resource.

Field Detail

SHUTDOWN_USE_COUNT

static final int SHUTDOWN_USE_COUNT

At how many uses should the real shutdown happen. This should be 0 but is here for allowing negative numbers (to mean never shutdown the shared resource)

See Also:

Constant Field Values

Method Detail

addUse

boolean addUse()

Attempts to mark a new use of this shared resources and returns whether or not the addition was successful

Returns:

True if a new use was registered, false if not (meaning it was already closed)

isClosed

boolean isClosed()

Returns whether or not this shared resource is closed. If closed it should no longer be used as underlying resources are no longer available. It should be noted that if this method is being called to check if another resource can use it, it is better to call the addUse() method which atomically checks for availability and adds a new use. Otherwise you might check and get it's useable but then have it be closed by the time you call the next method on it

Returns:

True if the underlying resources are closed, false otherwise.

getOpenCount

int getOpenCount()

Returns the number of open uses of the client

Returns:

The number of open uses of the client

registerUser

void registerUser(@NotNull
                  SharedResourceUser user)

Registers a user of the resource. Note this doesn't check if the resource is usable but is instead used for debugging to find leaks that aren't closed

Parameters:

user - The user to register

removeUser

void removeUser(@NotNull
                SharedResourceUser user)

Registers a user of the resource. Note this doesn't check if the resource is usable but is instead used for debugging to find leaks that aren't closed

Parameters:

user - The user to remove

getCurrentUsers

@NotNull
java.util.Set<SharedResourceUser> getCurrentUsers()

Returns a set of the current users of the client. Note that by the time this returns the set may no longer be accurate

Returns:

A set of the current users of the client. Note that by the time this returns the set may no longer be accurate

close

void close()
    throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception