LIM_pkt_send.h File Reference

Interface to the functions found in LIM_pkt_send.c. More...

#include <ITC/ITC_pubdefs.h>
#include <LIM/LIM_pubdefs.h>
#include <LIM_pool.h>

Classes
struct	_LIM_Pkt_Send_Status
	Status from a packet. More...
Typedefs
typedef struct _LIM_Pkt_Send	LIM_Pkt_Send
	Typedef for opaque LIM packet sending object handle.
typedef struct _LIM_Pkt_Send_Status	LIM_Pkt_Send_Status
	Typedef for _LIM_Pkt_Send_Status.
Functions
unsigned int	LIM_pkt_send_new (LIM_Pkt_Send **object_pp, LIM_Pool *pool_p)
	Create and initialize a new packet sending object.
unsigned int	LIM_pkt_send_delete (LIM_Pkt_Send *object_p)
	Shutdown and delete a packet sending object.
char *	LIM_pkt_send_get_desc (LIM_Pkt_Send *object_p)
	Return the description field for a packet.
ITC_TaskID	LIM_pkt_send_get_tid (LIM_Pkt_Send *object_p)
	Return the ID of the task associated with a packet.
unsigned int	LIM_pkt_set_info (LIM_Pkt_Send *object_p, ITC_NodeID nid, ITC_TaskID tid, ITC_QueueID qid, unsigned int apid, unsigned int func, int use_checksum, char *desc)
	Update information about a packet.
unsigned int	LIM_pkt_fwd_pkt (LIM_Pkt_Send *object_p, const ITC_QueueItem *qitem_p)
	Forward a packet.
unsigned int	LIM_pkt_send_cmd (LIM_Pkt_Send *object_p, const unsigned char *pkt_p, unsigned int pkt_bytes, ITC_QueueItem **status_qitem_pp)
	Send a command packet.
unsigned int	LIM_pkt_send_tlm (LIM_Pkt_Send *object_p, const unsigned char *pkt_p, unsigned int pkt_bytes)
	Send a telemetry packet.

---

Detailed Description

Interface to the functions found in LIM_pkt_send.c.

**  CVS $Id: LIM_pkt_send.h,v 1.10 2011/03/29 21:20:29 apw Exp $
**  

---

Function Documentation

unsigned int LIM_pkt_fwd_pkt	(	LIM_Pkt_Send *	object_p,
		const ITC_QueueItem *	qitem_p
	)

Forward a packet.

Parameters:

	object_p	Pointer to packet sending object.
	qitem_p	Pointer to queue item to forward.

Returns:

MSG code.

References lim_pkt_send_check(), _LIM_Pkt_Send::nid, _LIM_Pkt_Send::qid, and _LIM_Pkt_Send::tid.

Referenced by LIM_other_fwd_active(), LIM_other_fwd_idle(), and LIM_other_fwd_stop().

unsigned int LIM_pkt_send_cmd	(	LIM_Pkt_Send *	object_p,
		const unsigned char *	pkt_p,
		unsigned int	pkt_bytes,
		ITC_QueueItem **	status_qitem_pp
	)

Send a command packet.

Parameters:

	object_p	Pointer to packet sending object.
	pkt_p	Pointer to packet data.
	pkt_bytes	Size of packet data, in bytes.
	status_qitem_pp	Location to store pointer to queue item.

Returns:

MSG code.

References lim_pkt_send_check(), and lim_pkt_send_pkt().

Referenced by LIM_ltc_send_stop(), LIM_other_send_start(), LIM_other_send_stop(), and LIM_sc_send_slew_request().

unsigned int LIM_pkt_send_delete

(

LIM_Pkt_Send *

object_p

)

Shutdown and delete a packet sending object.

Parameters:

object_p

Pointer to packet sending object.

Returns:

MSG code.

References _LIM_Pkt_Send::key, and lim_pkt_send_check().

Referenced by lim_delete_pkt_send(), LIM_intercept_delete(), and LIM_pkt_send_new().

char* LIM_pkt_send_get_desc

(

LIM_Pkt_Send *

object_p

)

Return the description field for a packet.

Parameters:

object_p

Pointer to packet send object.

Returns:

Description field value from the packet.

References _LIM_Pkt_Send::desc, and lim_pkt_send_check().

ITC_TaskID LIM_pkt_send_get_tid

(

LIM_Pkt_Send *

object_p

)

Return the ID of the task associated with a packet.

Parameters:

object_p

Pointer to packet send object.

Returns:

Task ID field value from the packet.

References lim_pkt_send_check(), and _LIM_Pkt_Send::tid.

Referenced by LIM_mode_handle_bulk().

unsigned int LIM_pkt_send_new	(	LIM_Pkt_Send **	object_pp,
		LIM_Pool *	pool_p
	)

Create and initialize a new packet sending object.

Parameters:

	object_pp	Location to return pointer to new object.
	pool_p	Pointer to a memory pool object.

Returns:

MSG code.

References _LIM_Pkt_Send::desc, _LIM_Pkt_Send::func, _LIM_Pkt_Send::key, LIM_pkt_send_delete(), LIM_PKT_SEND_VALID_KEY, and _LIM_Pkt_Send::pool_p.

Referenced by LIM_initialize(), and lim_intercept_apid().

unsigned int LIM_pkt_send_tlm	(	LIM_Pkt_Send *	object_p,
		const unsigned char *	pkt_p,
		unsigned int	pkt_bytes
	)

Send a telemetry packet.

Parameters:

	object_p	Pointer to packet sending object.
	pkt_p	Pointer to packet data.
	pkt_bytes	Size of packet data, in bytes.

Returns:

MSG code.

References lim_pkt_send_check(), and lim_pkt_send_pkt().

Referenced by LIM_action_report(), lim_mode_load_shed(), LIM_sc_handle_slew_response(), and LIM_sc_send_slew_request().

unsigned int LIM_pkt_set_info	(	LIM_Pkt_Send *	object_p,
		ITC_NodeID	nid,
		ITC_TaskID	tid,
		ITC_QueueID	qid,
		unsigned int	apid,
		unsigned int	func,
		int	use_checksum,
		char *	desc
	)

Update information about a packet.

Parameters:

	object_p	Pointer to packet sending object.
	nid	ID of target node.
	tid	ID of target task.
	qid	ID of target queue.
	apid	APID of the packet.
	func	Function code of the packet.
	use_checksum	Flag to indicate if packet includes a checksum.
	desc	Description of the packet.

Returns:

MSG code.

References _LIM_Pkt_Send::apid, _LIM_Pkt_Send::desc, _LIM_Pkt_Send::func, lim_pkt_send_check(), _LIM_Pkt_Send::nid, _LIM_Pkt_Send::qid, _LIM_Pkt_Send::tid, and _LIM_Pkt_Send::use_checksum.

Referenced by LIM_action_new(), lim_intercept_command(), LIM_ltc_new(), LIM_mode_new(), and LIM_sc_new().