Utilities for extended‐binary date‐and‐time header encoding.

Synopsis

Declared in <balber_berutil.h>

struct BerUtil_DateAndTimeHeaderImpUtil;

Description

This component‐private utility struct provides a namespace for a suite of functions used by BerUtil to implement encoding and decoding operations for the 2‐byte header of extended‐binary‐encoding formatted date‐and‐time value.

Type Aliases

Name

Description

Header

Alias for the extended‐binary date‐and‐time header class.

StreambufUtil

StreambufUtil is an alias to a namespace for a suite of functions used to implement input and output operations on bsl::streambuf objects.

TimezoneUtil

TimezoneUtil is an alias to a namespace for a suite of functions used to implement BER encoding and decoding operations for time‐zone offset values.

Type

Alias for the extended‐binary header type enumeration.

Static Member Functions

Name

Description

detectType

If the specified firstByte of an encoded date‐and‐time value indicates it is in a compact‐binary‐encoding format or an ISO 8601 format, load the value.

detectTypeIfNotReserved

If the specified firstByte of an encoded date‐and‐time value indicates it is in a compact‐binary‐encoding format or an ISO 8601 format, load the value.

getValue

getValue overloads

getValueIfNotReserved

getValueIfNotReserved overloads

isExtendedBinary

Return true if the specified firstByte of an encoded date‐and‐time value indicates it is in the extended‐binary‐encoding format, and return false.

isExtendedBinaryWithTimezone

Return true if the specified firstByte if an encoded date‐and‐time value indicates is is in the extended‐binary‐encoding format and carries a time‐zone.

isExtendedBinaryWithoutTimezone

Return true if the specified firstByte of an encoded date‐and‐time value indicates it is in the extended‐binary‐encoding format and does not carry a.

isReserved

Return true if the specified firstByte of an encoded date‐and‐time value indicates it is in a format reserved for future use, and return false otherwise.

putExtendedBinaryWithTimezoneValue

Write a representation of an extended‐binary header value that carries the specified timezoneOffsetInMinutes time‐zone offset value to the specified.

putExtendedBinaryWithoutTimezoneValue

Write a representation of an extended‐binary header value that does not carry a time‐zone offset value to the specified streamBuf.

Static Data Members

Name

Description

k_HEADER_LENGTH

Number of octets used to encode an extended‐binary‐encoding header.

Created with MrDocs