pool.h File Reference

Pooled connections. More...

#include <ipxe/interface.h>
#include <ipxe/list.h>
#include <ipxe/retry.h>

Go to the source code of this file.

Data Structures
struct	pooled_connection
	A pooled connection. More...

Macros
#define	pool_recycle_TYPE(object_type)
#define	pool_reopen_TYPE(object_type)

Enumerations
enum	pooled_connection_flags { POOL_RECYCLABLE = 0x0001 , POOL_RECYCLED = 0x0002 , POOL_ALIVE = 0x0004 }
	Pooled connection flags. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
void	pool_add (struct pooled_connection *pool, struct list_head *list, unsigned long expiry)
	Add connection to pool.
void	pool_del (struct pooled_connection *pool)
	Remove connection from pool.
void	pool_expired (struct retry_timer *timer, int over)
	Close expired pooled connection.
static	__attribute__ ((always_inline)) void pool_init(struct pooled_connection *pool
	Initialise a pooled connection.
void	pool_recycle (struct interface *intf)
	Recycle this connection after closing.
void	pool_reopen (struct interface *intf)
	Reopen a defunct connection.

Variables
static void(*	expired )(struct pooled_connection *pool) = expired
static void struct refcnt *	refcnt
timer_init &	pool

Detailed Description

Pooled connections.

Definition in file pool.h.

Macro Definition Documentation

pool_recycle_TYPE

#define pool_recycle_TYPE

(

object_type

)

Value:

        typeof ( void ( object_type ) )

Definition at line 121 of file pool.h.

#define pool_recycle_TYPE( object_type ) \
        typeof ( void ( object_type ) )

pool_reopen_TYPE

#define pool_reopen_TYPE

(

object_type

)

Value:

        typeof ( void ( object_type ) )

Definition at line 125 of file pool.h.

#define pool_reopen_TYPE( object_type ) \
        typeof ( void ( object_type ) )

Enumeration Type Documentation

pooled_connection_flags

enum pooled_connection_flags

Pooled connection flags.

Enumerator
POOL_RECYCLABLE	Connection should be recycled after closing.
POOL_RECYCLED	Connection has been recycled.
POOL_ALIVE	Connection is known to be alive.

Definition at line 39 of file pool.h.

                             {
        /** Connection should be recycled after closing */
        POOL_RECYCLABLE = 0x0001,
        /** Connection has been recycled */
        POOL_RECYCLED = 0x0002,
        /** Connection is known to be alive */
        POOL_ALIVE = 0x0004,
};

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

pool_add()

void pool_add ( struct pooled_connection * pool, struct list_head * list, unsigned long expiry )

extern

Add connection to pool.

Parameters

pool	Pooled connection
list	List of pooled connections
expiry	Expiry time

Definition at line 64 of file pool.c.

                                       {
 
        /* Sanity check */
        assert ( list_empty ( &pool->list ) );
        assert ( ! timer_running ( &pool->timer ) );
 
        /* Add to list of pooled connections */
        list_add_tail ( &pool->list, list );
 
        /* Start expiry timer */
        start_timer_fixed ( &pool->timer, expiry );
}

References assert, list_add_tail, list_empty, pool, and start_timer_fixed().

Referenced by http_conn_xfer_close().

pool_del()

void pool_del ( struct pooled_connection * pool )

extern

Remove connection from pool.

Parameters

pool	Pooled connection

Definition at line 83 of file pool.c.

                                                 {
 
        /* Remove from list of pooled connections */
        list_del ( &pool->list );
        INIT_LIST_HEAD ( &pool->list );
 
        /* Stop expiry timer */
        stop_timer ( &pool->timer );
 
        /* Mark as a freshly recycled connection */
        pool->flags = POOL_RECYCLED;
}

References INIT_LIST_HEAD, list_del, pool, POOL_RECYCLED, and stop_timer().

Referenced by http_conn_close(), and http_connect().

pool_expired()

void pool_expired ( struct retry_timer * timer, int over __unused )

extern

Close expired pooled connection.

Parameters

timer	Expiry timer
over	Failure indicator

Definition at line 102 of file pool.c.

                                                                   {
        struct pooled_connection *pool =
                container_of ( timer, struct pooled_connection, timer );
 
        /* Sanity check */
        assert ( ! list_empty ( &pool->list ) );
 
        /* Remove from connection pool */
        list_del ( &pool->list );
        INIT_LIST_HEAD ( &pool->list );
 
        /* Close expired connection */
        pool->expired ( pool );
}

References __unused, assert, container_of, INIT_LIST_HEAD, list_del, list_empty, and pool.

__attribute__()

__attribute__ ( (always_inline) )

inlinestatic

Initialise a pooled connection.

Check if pooled connection is reopenable.

Check if pooled connection is recyclable.

Mark pooled connection as alive.

Mark pooled connection as recyclable.

Parameters

pool	Pooled connection
expired	Close expired pooled connection method
refcnt	Containing object reference counter
pool	Pooled connection
pool	Pooled connection

Return values

recyclable

Pooled connection is recyclable

Parameters

pool	Pooled connection

Return values

reopenable

Pooled connection is reopenable

Definition at line 75 of file pool.h.

                                                   {
 
        pool->flags |= POOL_RECYCLABLE;
}

References pool, and POOL_RECYCLABLE.

pool_recycle()

void pool_recycle ( struct interface * intf )

extern

Recycle this connection after closing.

Parameters

intf	Data transfer interface

Definition at line 42 of file pool.c.

                                             {
 
        intf_poke ( intf, pool_recycle );
}

References intf_poke(), and pool_recycle().

Referenced by http_transfer_complete(), and pool_recycle().

pool_reopen()

void pool_reopen ( struct interface * intf )

extern

Reopen a defunct connection.

Parameters

intf	Data transfer interface

Definition at line 52 of file pool.c.

                                            {
 
        intf_poke ( intf, pool_reopen );
}

References intf_poke(), and pool_reopen().

Referenced by http_conn_socket_close(), and pool_reopen().

Variable Documentation

expired

pool expired

(

struct pooled_connection *

pool

)

= expired

Definition at line 62 of file pool.h.

Referenced by ib_mi_timer_expired().

refcnt

timer refcnt

Initial value:

{
 
        INIT_LIST_HEAD ( &pool->list )

Definition at line 63 of file pool.h.

pool

timer_init & pool

Definition at line 66 of file pool.h.

Referenced by __attribute__(), http_conn_expired(), http_connect(), pool_add(), pool_del(), and pool_expired().