ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Deployments
    • Cloud
    • Server
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
    • Supported Driver Versions
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Install
Ask AI
ScyllaDB Docs ScyllaDB CPP RS Driver API Documentation CassAuthenticatorCallbacks

Caution

You're viewing documentation for an unstable version of ScyllaDB CPP RS Driver. Switch to the latest stable version.

CassAuthenticatorCallbacks¶

struct CassAuthenticatorCallbacks¶

Authenticator callbacks

Public Types

typedef void (*CassAuthenticatorInitialCallback)(CassAuthenticator *auth, void *data)¶

A callback used to initiate an authentication exchange.

Use cass_authenticator_set_response() to set the response token.

Use cass_authenticator_set_error() if an error occurred during initialization.

Param auth:

[in]

Param data:

[in]

typedef void (*CassAuthenticatorChallengeCallback)(CassAuthenticator *auth, void *data, const char *token, size_t token_size)¶

A callback used when an authentication challenge initiated by the server.

Use cass_authenticator_set_response() to set the response token.

Use cass_authenticator_set_error() if an error occurred during the challenge.

Param auth:

[in]

Param data:

[in]

Param token:

[in]

Param token_size:

[in]

typedef void (*CassAuthenticatorSuccessCallback)(CassAuthenticator *auth, void *data, const char *token, size_t token_size)¶

A callback used to indicate the success of the authentication exchange.

Use cass_authenticator_set_error() if an error occurred while evaluating the success token.

Param auth:

[in]

Param data:

[in]

Param token:

[in]

Param token_size:

[in]

typedef void (*CassAuthenticatorCleanupCallback)(CassAuthenticator *auth, void *data)¶

A callback used to cleanup resources that were acquired during the process of the authentication exchange. This is called after the termination of the exchange regardless of the outcome.

Param auth:

[in]

Param data:

[in]

typedef void (*CassAuthenticatorDataCleanupCallback)(void *data)¶

A callback used to cleanup resources.

Param data:

[in]

Public Members

CassAuthenticatorInitialCallback initial_callback¶
CassAuthenticatorChallengeCallback challenge_callback¶
CassAuthenticatorSuccessCallback success_callback¶
CassAuthenticatorCleanupCallback cleanup_callback¶

Was this page helpful?

PREVIOUS
CassAuthenticator
NEXT
CassBatch
  • Create an issue
  • Edit this page

On this page

  • CassAuthenticatorCallbacks
    • CassAuthenticatorCallbacks
      • CassAuthenticatorInitialCallback
      • CassAuthenticatorChallengeCallback
      • CassAuthenticatorSuccessCallback
      • CassAuthenticatorCleanupCallback
      • CassAuthenticatorDataCleanupCallback
      • initial_callback
      • challenge_callback
      • success_callback
      • cleanup_callback
ScyllaDB CPP RS Driver
  • master
    • master
    • v1.0.0
  • ScyllaDB CPP RS Driver
  • API Documentation
    • BasicTypes
    • CassConsistency
    • CassError
    • CassValueType
    • CustomAllocator
    • Logging
    • Miscellaneous
    • CassAggregateMeta
    • CassAuthenticator
    • CassAuthenticatorCallbacks
    • CassBatch
    • CassCluster
    • CassCollection
    • CassColumnMeta
    • CassCustomPayload
    • CassDataType
    • CassErrorResult
    • CassExecProfile
    • CassFunctionMeta
    • CassFuture
    • CassIndexMeta
    • CassInet
    • CassIterator
    • CassKeyspaceMeta
    • CassMaterializedViewMeta
    • CassMetrics
    • CassNode
    • CassPrepared
    • CassResult
    • CassRetryPolicy
    • CassRow
    • CassSchemaMeta
    • CassSession
    • CassSpeculativeExecutionMetrics
    • CassSsl
    • CassStatement
    • CassTableMeta
    • CassTimestampGen
    • CassTuple
    • CassUserType
    • CassUuid
    • CassUuidGen
    • CassValue
    • CassVersion
  • Getting Started
  • Architecture Overview
  • Installation
  • Building
  • Testing
  • Using the Driver
    • Batches
    • Binding Parameters
    • Client-side timestamps
    • Consistency
    • Data Types
      • The date and time Types
      • Tuples
      • User-Defined Types (UDTs)
      • UUIDs
    • Futures
    • Handling Results
    • Keyspaces
    • Prepared Statements
    • Schema Metadata
  • Configuration
    • Load balancing
    • Retry policies
    • Speculative Execution
    • Connection
    • Execution Profiles
    • Performance Tips
    • Client Configuration
  • Security
    • Authentication
    • TLS
  • Observability
    • Logging
    • Tracing
    • Metrics
Docs Tutorials University Contact Us About Us
© 2026, ScyllaDB. All rights reserved. | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 17 Mar 2026.
Powered by Sphinx 9.1.0 & ScyllaDB Theme 1.9.1
Ask AI