Class NonOwnedOpenSslCredential

java.lang.Object

io.netty.util.AbstractReferenceCounted

io.netty.handler.ssl.NonOwnedOpenSslCredential

All Implemented Interfaces:

OpenSslCredential, OpenSslCredentialPointer, ReferenceCounted

final class NonOwnedOpenSslCredential
extends AbstractReferenceCounted
implements OpenSslCredentialPointer

A non-owning wrapper for an OpenSslCredential pointer.

This class is used when we need to expose an SSL_CREDENTIAL pointer that is managed by OpenSSL itself (e.g., the credential selected during the handshake). Unlike DefaultOpenSslCredential, this wrapper does not free the underlying credential when its reference count reaches zero, as the lifetime is managed externally.

This is a BoringSSL-specific feature.

Nested Class Summary

Nested classes/interfaces inherited from interface OpenSslCredential

OpenSslCredential.CredentialType

Field Summary

Fields

Modifier and Type	Field	Description
private final long	credential
private boolean	released
private final OpenSslCredential.CredentialType	type

Constructor Summary

Constructors

Constructor	Description
NonOwnedOpenSslCredential(long credential, OpenSslCredential.CredentialType type)	Creates a new non-owning credential wrapper.

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.
OpenSslCredential	retain()	Increases the reference count by 1.
OpenSslCredential	retain(int increment)	Increases the reference count by the specified increment.
OpenSslCredential	touch()	Records the current access location of this object for debugging purposes.
OpenSslCredential	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, release, release, setRefCnt

Methods inherited from class Object

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

Methods inherited from interface ReferenceCounted

refCnt, release, release

Field Details

credential

private final long credential

type

private final OpenSslCredential.CredentialType type

released

private volatile boolean released

Constructor Details

NonOwnedOpenSslCredential

NonOwnedOpenSslCredential(long credential,
 OpenSslCredential.CredentialType type)

Creates a new non-owning credential wrapper.

Parameters:

credential - the native SSL_CREDENTIAL pointer (must not be 0)

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

retain

public OpenSslCredential 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 OpenSslCredential 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 OpenSslCredential 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 OpenSslCredential 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

deallocate

protected void deallocate()

Description copied from class: AbstractReferenceCounted

Called once AbstractReferenceCounted.refCnt() is equals 0.

Specified by:

deallocate in class AbstractReferenceCounted