Class DefaultOpenSslCredential

java.lang.Object

io.netty.util.AbstractReferenceCounted

io.netty.handler.ssl.DefaultOpenSslCredential

All Implemented Interfaces:

OpenSslCredential, OpenSslCredentialPointer, ReferenceCounted

final class DefaultOpenSslCredential
extends AbstractReferenceCounted
implements OpenSslCredentialPointer

Default implementation of OpenSslCredential.

This class manages the lifecycle of a native BoringSSL SSL_CREDENTIAL object.

Nested Class Summary

Nested classes/interfaces inherited from interface OpenSslCredential

OpenSslCredential.CredentialType

Field Summary

Fields

Modifier and Type	Field	Description
private long	credential
private final ResourceLeakTracker<DefaultOpenSslCredential>	leak
private static final ResourceLeakDetector<DefaultOpenSslCredential>	leakDetector
private final OpenSslCredential.CredentialType	type

Constructor Summary

Constructors

Constructor	Description
DefaultOpenSslCredential(long credential, OpenSslCredential.CredentialType type)	Creates a new credential instance.

Method Summary

Modifier and Type	Method	Description
long	credentialAddress()	Returns the native SSL_CREDENTIAL pointer address.
protected void	deallocate()	Called once AbstractReferenceCounted.refCnt() is equals 0.
boolean	release()	Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.
boolean	release(int decrement)	Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.
DefaultOpenSslCredential	retain()	Increases the reference count by 1.
DefaultOpenSslCredential	retain(int increment)	Increases the reference count by the specified increment.
DefaultOpenSslCredential	touch()	Records the current access location of this object for debugging purposes.
DefaultOpenSslCredential	touch(Object hint)	Records the current access location of this object with an additional arbitrary information for debugging purposes.
OpenSslCredential.CredentialType	type()	Returns the type of this credential.

Methods inherited from class AbstractReferenceCounted

refCnt, setRefCnt

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ReferenceCounted

refCnt

Field Details

leakDetector

private static final ResourceLeakDetector<DefaultOpenSslCredential> leakDetector

leak

private final ResourceLeakTracker<DefaultOpenSslCredential> leak

type

private final OpenSslCredential.CredentialType type

credential

private long credential

Constructor Details

DefaultOpenSslCredential

DefaultOpenSslCredential(long credential,
 OpenSslCredential.CredentialType type)

Creates a new credential instance.

Parameters:

credential - the native SSL_CREDENTIAL pointer

type - the credential type

Method Details

credentialAddress

public long credentialAddress()

Description copied from interface: OpenSslCredentialPointer

Returns the native SSL_CREDENTIAL pointer address.

Specified by:

credentialAddress in interface OpenSslCredentialPointer

Returns:

the native pointer address

type

public OpenSslCredential.CredentialType type()

Description copied from interface: OpenSslCredential

Returns the type of this credential.

Specified by:

type in interface OpenSslCredential

Returns:

the credential type

deallocate

protected void deallocate()

Description copied from class: AbstractReferenceCounted

Called once AbstractReferenceCounted.refCnt() is equals 0.

Specified by:

deallocate in class AbstractReferenceCounted

retain

public DefaultOpenSslCredential retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface OpenSslCredential

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class AbstractReferenceCounted

retain

public DefaultOpenSslCredential retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface OpenSslCredential

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class AbstractReferenceCounted

touch

public DefaultOpenSslCredential touch()

Description copied from interface: ReferenceCounted

Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector. This method is a shortcut to touch(null).

Specified by:

touch in interface OpenSslCredential

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class AbstractReferenceCounted

touch

public DefaultOpenSslCredential touch(Object hint)

Description copied from interface: ReferenceCounted

Records the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector.

Specified by:

touch in interface OpenSslCredential

Specified by:

touch in interface ReferenceCounted

release

public boolean release()

Description copied from interface: ReferenceCounted

Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.

Specified by:

release in interface ReferenceCounted

Overrides:

release in class AbstractReferenceCounted

Returns:

true if and only if the reference count became 0 and this object has been deallocated

release

public boolean release(int decrement)

Description copied from interface: ReferenceCounted

Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.

Specified by:

release in interface ReferenceCounted

Overrides:

release in class AbstractReferenceCounted

Returns:

true if and only if the reference count became 0 and this object has been deallocated