kinetic-c  v0.12.0
Seagate Kinetic Protocol Client Library for C
Data Fields
KineticSessionConfig Struct Reference

Structure used to specify the configuration for a session. More...

#include <kinetic_types.h>

Data Fields

char host [256]
 Host name/IP address of Kinetic Device. More...
 
int port
 Port for Kinetic Device session. More...
 
int64_t clusterVersion
 The version number of this cluster definition. More...
 
int64_t identity
 The identity associated with this request. More...
 
uint8_t keyData [(4096)]
 This is the identity's HMAC Key. More...
 
ByteArray hmacKey
 
bool useSsl
 Set to `true' to enable SSL for for this session. More...
 
uint16_t timeoutSeconds
 Operation timeout. If 0, use the default (10 seconds). More...
 

Detailed Description

Structure used to specify the configuration for a session.

Definition at line 118 of file kinetic_types.h.

Field Documentation

char KineticSessionConfig::host[256]

Host name/IP address of Kinetic Device.

Definition at line 120 of file kinetic_types.h.

int KineticSessionConfig::port

Port for Kinetic Device session.

Definition at line 123 of file kinetic_types.h.

int64_t KineticSessionConfig::clusterVersion

The version number of this cluster definition.

If this is not equal to the value on the Kinetic Device, the request is rejected and will return KINETIC_STATUS_VERSION_FAILURE

Definition at line 128 of file kinetic_types.h.

int64_t KineticSessionConfig::identity

The identity associated with this request.

See the ACL discussion above. The Kinetic Device will use this identity value to lookup the HMAC key (shared secret) to verify the HMAC.

Definition at line 133 of file kinetic_types.h.

uint8_t KineticSessionConfig::keyData[(4096)]

This is the identity's HMAC Key.

This is a shared secret between the client and the device, used to sign requests.

Definition at line 137 of file kinetic_types.h.

ByteArray KineticSessionConfig::hmacKey

Definition at line 138 of file kinetic_types.h.

bool KineticSessionConfig::useSsl

Set to `true' to enable SSL for for this session.

Definition at line 141 of file kinetic_types.h.

uint16_t KineticSessionConfig::timeoutSeconds

Operation timeout. If 0, use the default (10 seconds).

Definition at line 144 of file kinetic_types.h.


The documentation for this struct was generated from the following file: