ObjFW
Classes | Enumerations | Functions | Variables
OFTLSStream.h File Reference
#import "OFStream.h"
#import "OFRunLoop.h"

Go to the source code of this file.

Classes

class  OFTLSStream
 A class that provides Transport Layer Security on top of a stream. More...
 

Enumerations

enum  OFTLSStreamErrorCode { OFTLSStreamErrorCodeUnknown, OFTLSStreamErrorCodeInitializationFailed }
 An enum representing an error of an OFTLSStream. More...
 

Functions

OFStringOFTLSStreamErrorCodeDescription (OFTLSStreamErrorCode errorCode)
 Returns a string description for the TLS stream error code. More...
 

Variables

Class OFTLSStreamImplementation
 The implementation for OFTLSStream to use. More...
 

Enumeration Type Documentation

◆ OFTLSStreamErrorCode

An enum representing an error of an OFTLSStream.

Enumerator
OFTLSStreamErrorCodeUnknown 

An unknown error.

OFTLSStreamErrorCodeInitializationFailed 

Initialization of the TLS context failed.

Function Documentation

◆ OFTLSStreamErrorCodeDescription()

OFString* OFTLSStreamErrorCodeDescription ( OFTLSStreamErrorCode  errorCode)

Returns a string description for the TLS stream error code.

Parameters
errorCodeThe error code to return the description for
Returns
A string description for the TLS stream error code

Variable Documentation

◆ OFTLSStreamImplementation

Class OFTLSStreamImplementation

The implementation for OFTLSStream to use.

This can be set to a class that is always used for OFTLSStream. This is useful to either force a specific implementation or use one that ObjFW does not know about.