ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Download
ScyllaDB Docs Scylla C/C++ Driver API Documentation CassAuthenticator

CassAuthenticator¶

struct CassAuthenticator¶

An authenticator.

Public Functions

void cass_authenticator_address(const CassAuthenticator *auth, CassInet *address)¶

Gets the IP address of the host being authenticated.

Parameters:
  • auth – [in]

  • address – [out]

const char *cass_authenticator_hostname(const CassAuthenticator *auth, size_t *length)¶

Gets the hostname of the host being authenticated.

Parameters:
  • auth – [in]

  • length – [out]

Returns:

A null-terminated string.

const char *cass_authenticator_class_name(const CassAuthenticator *auth, size_t *length)¶

Gets the class name for the server-side IAuthentication implementation.

Parameters:
  • auth – [in]

  • length – [out]

Returns:

A null-terminated string.

void *cass_authenticator_exchange_data(CassAuthenticator *auth)¶

Gets the user data created during the authenticator exchange. This is set using cass_authenticator_set_exchange_data().

See also

cass_authenticator_set_exchange_data()

Parameters:

auth – [in]

Returns:

User specified exchange data previously set by cass_authenticator_set_exchange_data().

void cass_authenticator_set_exchange_data(CassAuthenticator *auth, void *exchange_data)¶

Sets the user data to be used during the authenticator exchange.

See also

cass_authenticator_exchange_data()

Parameters:
  • auth – [in]

  • exchange_data –

char *cass_authenticator_response(CassAuthenticator *auth, size_t size)¶

Gets a response token buffer of the provided size.

Parameters:
  • auth – [in]

  • size – [in]

Returns:

A buffer to copy the response token.

void cass_authenticator_set_response(CassAuthenticator *auth, const char *response, size_t response_size)¶

Sets the response token.

Parameters:
  • auth – [in]

  • response – [in]

  • response_size – [in]

void cass_authenticator_set_error(CassAuthenticator *auth, const char *message)¶

Sets an error for the authenticator exchange.

Parameters:
  • auth – [in]

  • message – [in]

void cass_authenticator_set_error_n(CassAuthenticator *auth, const char *message, size_t message_length)¶

Same as cass_authenticator_set_error(), but with lengths for string parameters.

See also

cass_authenticator_set_error()

Parameters:
  • auth – [in]

  • message – [in]

  • message_length –

Was this page helpful?

PREVIOUS
CassAggregateMeta
NEXT
CassAuthenticatorCallbacks
  • Create an issue
  • Edit this page

On this page

  • CassAuthenticator
    • CassAuthenticator
      • CassAuthenticator::cass_authenticator_address()
      • CassAuthenticator::cass_authenticator_hostname()
      • CassAuthenticator::cass_authenticator_class_name()
      • CassAuthenticator::cass_authenticator_exchange_data()
      • CassAuthenticator::cass_authenticator_set_exchange_data()
      • CassAuthenticator::cass_authenticator_response()
      • CassAuthenticator::cass_authenticator_set_response()
      • CassAuthenticator::cass_authenticator_set_error()
      • CassAuthenticator::cass_authenticator_set_error_n()
Scylla C/C++ Driver
  • master
    • master
  • C/C++ Driver for ScyllaDB
  • API Documentation
    • CassAggregateMeta
    • CassAuthenticator
    • CassAuthenticatorCallbacks
    • CassBatch
    • CassCluster
    • CassCollection
    • CassColumnMeta
    • CassCustomPayload
    • CassDataType
    • CassErrorResult
    • CassExecProfile
    • CassFunctionMeta
    • CassFuture
    • CassIndexMeta
    • CassInet
    • CassIterator
    • CassKeyspaceMeta
    • CassLogMessage
    • CassMaterializedViewMeta
    • CassMetrics
    • CassNode
    • CassPrepared
    • CassResult
    • CassRetryPolicy
    • CassRow
    • CassSchemaMeta
    • CassSession
    • CassSpeculativeExecutionMetrics
    • CassSsl
    • CassStatement
    • CassTableMeta
    • CassTimestampGen
    • CassTuple
    • CassUserType
    • CassUuid
    • CassUuidGen
    • CassValue
    • CassVersion
    • DseDateRange
    • DseDateRangeBound
    • DseLineString
    • DseLineStringIterator
    • DsePolygon
    • DsePolygonIterator
  • Features
    • Basics
      • Batches
      • Binding Parameters
      • Client-side timestamps
      • Consistency
      • Data Types
      • The date and time Types
      • Futures
      • Handling Results
      • Keyspaces
      • Prepared Statements
      • Schema Metadata
      • Tuples
      • User-Defined Types (UDTs)
      • UUIDs
    • Building
    • Client Configuration
    • Cloud
    • Configuration
      • Retry policies
    • Execution Profiles
    • FAQ
    • Installation
    • Logging
    • Metrics
    • Scylla Specific Features
    • Security
      • SSL
    • Testing
      • Cassandra Cluster Manager (CCM)
    • Tracing
  • DSE Features
    • Authentication
    • Geospatial types
Docs Tutorials University Contact Us About Us
© 2025, ScyllaDB. All rights reserved. | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 28 April 2025.
Powered by Sphinx 7.4.7 & ScyllaDB Theme 1.8.6