A typesafe list of Connection objects. More...

#include <hicn/core/connection.h>

Include dependency graph for connectionList.h:

This graph shows which files directly or indirectly include this file:

Typedefs
typedef struct connection_list	ConnectionList

Functions
ConnectionList *	connectionList_Create (void)

void	connectionList_Destroy (ConnectionList **listPtr)

void	connectionList_Append (ConnectionList list, Connection entry)

size_t	connectionList_Length (const ConnectionList *list)

Connection *	connectionList_Get (ConnectionList *list, size_t index)

Detailed Description

A typesafe list of Connection objects.

<#Detailed Description#>

Function Documentation

◆ connectionList_Append()

void connectionList_Append	(	ConnectionList *	list,
		Connection *	entry
	)

@function connectionList_Append @abstract Adds a connection entry to the list. @discussion Acquires a reference to the passed entry and stores it in the list.

◆ connectionList_Create()

ConnectionList* connectionList_Create ( void )

Creates a lis of Connection

Returns: non-null An allocated list; null An error

◆ connectionList_Destroy()

void connectionList_Destroy ( ConnectionList ** listPtr )

Destroys the list and all objects inside it

◆ connectionList_Get()

Connection* connectionList_Get	(	ConnectionList *	list,
		size_t	index
	)

@function connectionList_Get @abstract Returns the connection entry. @discussion Caller must not destroy the returned value. If you will store the entry in your own data structure, you should acquire your own reference. Will assert if you go beyond the end of the list.

◆ connectionList_Length()

size_t connectionList_Length ( const ConnectionList * list )

Returns the number of items on the list

Parameters

[in] list The allocated list to check

Returns: number The number of items on the list

Typedefs