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 CassCustomPayload

Caution

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

CassCustomPayload¶

struct CassCustomPayload¶

Public Functions

CassCustomPayload *cass_custom_payload_new()¶

Creates a new custom payload.

Warning: This function is not yet implemented.

See also

cass_custom_payload_free()

Returns:

Returns a custom payload that must be freed.

void cass_custom_payload_free(CassCustomPayload *payload)¶

Frees a custom payload instance.

Warning: This function is not yet implemented.

Parameters:

payload – [in]

void cass_custom_payload_set(CassCustomPayload *payload, const char *name, const cass_byte_t *value, size_t value_size)¶

Sets an item to the custom payload.

Warning: This function is not yet implemented.

Parameters:
  • payload – [in]

  • name – [in]

  • value – [in]

  • value_size – [in]

void cass_custom_payload_set_n(CassCustomPayload *payload, const char *name, size_t name_length, const cass_byte_t *value, size_t value_size)¶

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

Warning: This function is not yet implemented.

Parameters:
  • payload – [in]

  • name – [in]

  • name_length – [in]

  • value – [in]

  • value_size – [in]

void cass_custom_payload_remove(CassCustomPayload *payload, const char *name)¶

Removes an item from the custom payload.

Warning: This function is not yet implemented.

Parameters:
  • payload – [in]

  • name – [in]

void cass_custom_payload_remove_n(CassCustomPayload *payload, const char *name, size_t name_length)¶

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

Warning: This function is not yet implemented.

Parameters:
  • payload – [in]

  • name – [in]

  • name_length – [in]

Was this page helpful?

PREVIOUS
CassColumnMeta
NEXT
CassDataType
  • Create an issue
  • Edit this page

On this page

  • CassCustomPayload
    • CassCustomPayload
      • cass_custom_payload_new()
      • cass_custom_payload_free()
      • cass_custom_payload_set()
      • cass_custom_payload_set_n()
      • cass_custom_payload_remove()
      • cass_custom_payload_remove_n()
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