Edit

Thread events

This page contains reference entries in the Events API family. Each entry includes its declaration and requirements.

Thread creation

ESP_THREAD_CREATE_FLAGS

The enum ESP_THREAD_CREATE_FLAGS defines flags for the thread create event.

Syntax

typedef enum ESP_THREAD_CREATE_FLAGS
{
    ESP_THREAD_CREATE_FLAGS_NONE   = 0x00000000,
    ESP_THREAD_CREATE_FLAGS_REMOTE = 0x00000001
} ESP_THREAD_CREATE_FLAGS;

Values

VALUE DESCRIPTION
ESP_THREAD_CREATE_FLAGS_REMOTE The thread was created as a remote thread (e.g. using the API CreateRemoteThread).

Requirements

Requirement Value
Header esptypes.h

See also

ESP_THREAD_CREATE_CONFIG

The structure ESP_THREAD_CREATE_CONFIG is used to configure a thread create event.

Syntax

typedef struct ESP_THREAD_CREATE_CONFIG
{
    ESP_THREAD_CONFIG ThreadConfig;
    ESP_INTEGER_CONFIG FlagsConfig;
} ESP_THREAD_CREATE_CONFIG;

Members

FIELD DESCRIPTION
ThreadConfig Specifies configuration for the thread being created.
FlagsConfig Specifies configuration for the flags.

Requirements

Requirement Value
Header esptypes.h

See also

ESP_THREAD_CREATE_PARAMETERS

The structure ESP_THREAD_CREATE_PARAMETERS contains the parameters associated with a thread create event notification.

Syntax

typedef struct ESP_THREAD_CREATE_PARAMETERS
{
    ESP_THREAD_INFO Thread;
    ESP_THREAD_CREATE_FLAGS Flags;
} ESP_THREAD_CREATE_PARAMETERS;

Members

FIELD DESCRIPTION
Thread The thread that is being created.
Flags Flags for the thread create event. The supported flags are:
RemoteThread: Indicates the thread is a remote thread.

Requirements

Requirement Value
Header esptypes.h

See also

Thread start

ESP_THREAD_START_CONFIG

The structure ESP_THREAD_START_CONFIG is used to configure a thread start event.

Syntax

typedef struct ESP_THREAD_START_CONFIG
{
    ESP_THREAD_CONFIG ThreadConfig;
} ESP_THREAD_START_CONFIG;

Members

FIELD DESCRIPTION
ThreadConfig Specifies configuration for the thread being started.

Requirements

Requirement Value
Header esptypes.h

See also

ESP_THREAD_START_PARAMETERS

The structure ESP_THREAD_START_PARAMETERS contains the parameters associated with a thread start event notification.

Syntax

typedef struct ESP_THREAD_START_PARAMETERS
{
    ESP_THREAD_INFO Thread;
} ESP_THREAD_START_PARAMETERS;

Members

FIELD DESCRIPTION
Thread The thread that is being started.

Requirements

Requirement Value
Header esptypes.h

See also

Thread termination

ESP_THREAD_TERMINATE_CONFIG

The structure ESP_THREAD_TERMINATE_CONFIG is used to configure a thread terminate event.

Syntax

typedef struct ESP_THREAD_TERMINATE_CONFIG
{
    ESP_THREAD_CONFIG ThreadConfig;
} ESP_THREAD_TERMINATE_CONFIG;

Members

FIELD DESCRIPTION
ThreadConfig Specifies configuration for the thread being terminated.

Requirements

Requirement Value
Header esptypes.h

See also

ESP_THREAD_TERMINATE_PARAMETERS

The structure ESP_THREAD_TERMINATE_PARAMETERS contains the parameters associated with a thread terminate event notification.

Syntax

typedef struct ESP_THREAD_TERMINATE_PARAMETERS
{
    ESP_THREAD_INFO Thread;
} ESP_THREAD_TERMINATE_PARAMETERS;

Members

FIELD DESCRIPTION
Thread The thread that is being terminated.

Requirements

Requirement Value
Header esptypes.h

See also