Jump to main content

##

# TCPIP_STACK_HEAP_USAGE Enumeration

## C

    typedef enum {
    TCPIP_STACK_HEAP_USE_DEFAULT = 0x00,
    TCPIP_STACK_HEAP_USE_GENERIC = 0x01,
    TCPIP_STACK_HEAP_USE_PACKET = 0x02,
    TCPIP_STACK_HEAP_USE_SOCKET_TCP = 0x04,
    TCPIP_STACK_HEAP_USE_SOCKET_UDP = 0x08,
    TCPIP_STACK_HEAP_USE_POOL_UDP = 0x10
    } TCPIP_STACK_HEAP_USAGE;

## Description

Enumeration: TCPIP_STACK_HEAP_USAGE.

Definition of the heap usage/purpose. It defines what modules in the TCP/IP stack will use this heap.

## Preconditions

None.

## Members

Members | Description
--- | ---
TCPIP_STACK_HEAP_USE_DEFAULT = 0x00 | Default heap usage.
TCPIP_STACK_HEAP_USE_GENERIC = 0x01 | Generic heap usage.
TCPIP_STACK_HEAP_USE_PACKET = 0x02 | Heap for packet allocations.
TCPIP_STACK_HEAP_USE_SOCKET_TCP = 0x04 | Heap for TCP sockets.
TCPIP_STACK_HEAP_USE_SOCKET_UDP = 0x08 | Heap for UDP sockets.
TCPIP_STACK_HEAP_USE_POOL_UDP = 0x10 | Heap for UDP TX pool buffers.

## Remarks

This is an advanced definition that is currently not used. Multiple heaps usage will be added in the future. For now, only one heap type is supported and it is used for all allocation operations. New usages could be eventually added. Multiple usage flags can be simultaneously set.