Epok Engine

EPOK RUNTIME

epok::PocketRequest::begin

Method · 1 overload

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Method

Begins begin as part of the pocketstation async module.

Belongs to
epok::PocketRequest
Header
pocketstation_async.hpp
Overloads
1

Declaration

Declaration
bool begin(unsigned port,const uint8_t* data,uint16_t length,int16_t length_at=-1)

Begins begin as part of the pocketstation async module.

ParameterTypeMeaning
portunsigned intNot documented; consult the linked header.
dataconst uint8_t *Not documented; consult the linked header.
lengthuint16_tNot documented; consult the linked header.
length_atint16_tNot documented; consult the linked header.

Returns: bool. Consult the linked header for its meaning.

Example sketch

C++ example
#include "pocketstation_async.hpp"

// Assume these named values have been initialized with valid data:
// unsigned int port
// const uint8_t * data
// uint16_t length
// int16_t length_at

epok::PocketRequest& object = /* obtain a valid instance */;

auto result = object.begin(port, data, length, length_at);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/pocketstation_async.hpp:58

Related members