com.relayrides.pushy.apns

Class ApnsConnectionConfiguration

java.lang.Object

com.relayrides.pushy.apns.ApnsConnectionConfiguration

public class ApnsConnectionConfiguration
extends Object

A set of user-configurable options that affect the behavior of an ApnsConnection.

Author:

Jon Chambers

Constructor Summary

Constructors

Constructor and Description
ApnsConnectionConfiguration() Creates a new connection configuration object with all options set to their default values.
ApnsConnectionConfiguration(ApnsConnectionConfiguration configuration) Creates a new connection configuration object with all options set to the values in the given connection configuration object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Integer	getCloseAfterInactivityTime() Returns the time, in seconds, between the sending of the last push notification and connection closure.
Integer	getGracefulShutdownTimeout() Returns the time, in seconds, after which a graceful shutdown attempt should be abandoned and the connection should be closed immediately.
Integer	getSendAttemptLimit() Returns the number of notifications a connection may attempt to send before shutting down.
int	getSentNotificationBufferCapacity() Returns the sent notification buffer capacity for connections created with this configuration.
int	hashCode()
void	setCloseAfterInactivityTime(Integer closeAfterInactivityTime) Sets the time, in seconds, between the sending of the last push notification and connection closure.
void	setGracefulShutdownTimeout(Integer gracefulShutdownTimeout) Sets the time, in seconds, after which a graceful shutdown attempt should be abandoned and the connection should be closed immediately.
void	setSendAttemptLimit(Integer sendAttemptLimit) Sets the number of notifications a connection may attempt to send before shutting down.
void	setSentNotificationBufferCapacity(int sentNotificationBufferCapacity) Sets the sent notification buffer capacity for connections created with this configuration.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApnsConnectionConfiguration

public ApnsConnectionConfiguration()

Creates a new connection configuration object with all options set to their default values.

ApnsConnectionConfiguration

public ApnsConnectionConfiguration(ApnsConnectionConfiguration configuration)

Creates a new connection configuration object with all options set to the values in the given connection configuration object.

Parameters:

configuration - the configuration object to copy

Method Detail

getSentNotificationBufferCapacity

public int getSentNotificationBufferCapacity()

Returns the sent notification buffer capacity for connections created with this configuration.

Returns:

the sent notification buffer capacity for connections created with this configuration

setSentNotificationBufferCapacity

public void setSentNotificationBufferCapacity(int sentNotificationBufferCapacity)

Sets the sent notification buffer capacity for connections created with this configuration. The default capacity is 8192 notifications. While sent notification buffers may have any positive capacity, it is not recommended that they be given a capacity less than the default.

Parameters:

sentNotificationBufferCapacity - the sent notification buffer capacity for connections created with this configuration

getCloseAfterInactivityTime

public Integer getCloseAfterInactivityTime()

Returns the time, in seconds, between the sending of the last push notification and connection closure. If null, connections created with this configuration will never be closed due to inactivity.

Returns:

the time, in seconds, between the sending of the last push notification and connection closure

setCloseAfterInactivityTime

public void setCloseAfterInactivityTime(Integer closeAfterInactivityTime)

Sets the time, in seconds, between the sending of the last push notification and connection closure. If null (the default), connections will never be closed due to inactivity.

Parameters:

closeAfterInactivityTime - the time, in seconds, between the sending of the last push notification and connection closure

getGracefulShutdownTimeout

public Integer getGracefulShutdownTimeout()

Returns the time, in seconds, after which a graceful shutdown attempt should be abandoned and the connection should be closed immediately.

Returns:

the time, in seconds, after which a graceful shutdown attempt should be abandoned and the connection should be closed immediately

setGracefulShutdownTimeout

public void setGracefulShutdownTimeout(Integer gracefulShutdownTimeout)

Sets the time, in seconds, after which a graceful shutdown attempt should be abandoned and the connection should be closed immediately. If null (the default) graceful shutdown attempts will never time out. Note that, if a graceful shutdown attempt times out, no guarantees are made as to the state of notifications sent by the connection.

Parameters:

gracefulShutdownTimeout - the time, in seconds, after which a graceful shutdown attempt should be abandoned

getSendAttemptLimit

public Integer getSendAttemptLimit()

Returns the number of notifications a connection may attempt to send before shutting down.

Returns:

the number of notifications a connection may attempt to send before shutting down, or null if no limit has been set

setSendAttemptLimit

public void setSendAttemptLimit(Integer sendAttemptLimit)

Sets the number of notifications a connection may attempt to send before shutting down. If not null, connections will attempt to shut down gracefully after the given number of send attempts regardless of whether those attempts were actually successful. By default, no limit is set.

If the a send attempt limit is set and is less than the sent notification buffer size, it is guaranteed that notifications will never be lost due to buffer overruns (though they may be lost by other means, such as non- graceful shutdowns).

Parameters:

sendAttemptLimit - the number of notifications the connection may attempt to send before shutting down gracefully; if null, no limit is set

See Also:

setSentNotificationBufferCapacity(int)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object