fti.xif

来自「BCAST Implementation for NS2」· XIF 代码 · 共 255 行

/* $XORP: xorp/xrl/interfaces/fti.xif,v 1.3 2003/09/12 23:43:39 pavlin Exp $ */

/*
 * Forwarding Table XRL interface (typically used by RIB clients).
 */

interface fti/0.2 {

	/**
	 * Start transaction.
	 * 
	 * @param tid the transaction ID to use for this transaction.
	 */
	start_transaction -> tid:u32

	/**
	 * Commit transaction.
	 * 
	 * @param tid the transaction ID of this transaction.
	 */
	commit_transaction ? tid:u32

	/**
	 * Abort transaction.
	 * 
	 * @param tid the transaction ID of this transaction.
	 */
	abort_transaction ? tid:u32

	/**
	 * Add a routing entry.
	 * 
	 * @param tid the transaction ID of this transaction.
	 * @param dst the destination subnet address of the entry.
	 * @param gateway the address of the next-hop router toward dst.
	 * @param ifname the name of the physical interface toward dst.
	 * @param vifname the name of the virtual interface toward dst.
	 * @param metric the routing metric toward dst.
	 * @param admin_distance the administratively defined distance
	 * toward dst.
	 * @param protocol_origin the name of the protocol that originated
	 * this entry.
	 */
	add_entry4 ? tid:u32 &						\
		     dst:ipv4net &					\
		     gateway:ipv4 &					\
		     ifname:txt &					\
		     vifname:txt &					\
		     metric:u32 &					\
		     admin_distance:u32 &				\
		     protocol_origin:txt

	/**
	 * Add a routing entry.
	 * 
	 * @param tid the transaction ID of this transaction.
	 * @param dst the destination subnet address of the entry.
	 * @param gateway the address of the next-hop router toward dst.
	 * @param ifname the name of the physical interface toward dst.
	 * @param vifname the name of the virtual interface toward dst.
	 * @param metric the routing metric toward dst.
	 * @param admin_distance the administratively defined distance
	 * toward dst.
	 * @param protocol_origin the name of the protocol that originated
	 * this entry.
	 */
	add_entry6 ? tid:u32 &						\
		     dst:ipv6net &					\
		     gateway:ipv6 &					\
		     ifname:txt &					\
		     vifname:txt &					\
		     metric:u32 &					\
		     admin_distance:u32 &				\
		     protocol_origin:txt

	/**
	 * Delete a routing entry.
	 * 
	 * @param tid the transaction ID of this transaction.
	 * @param dst the destination subnet address of the entry.
	 */
	delete_entry4 ? tid:u32 & dst:ipv4net

	/**
	 * Delete a routing entry.
	 * 
	 * @param tid the transaction ID of this transaction.
	 * @param dst the destination subnet address of the entry.
	 */
	delete_entry6 ? tid:u32 & dst:ipv6net

	/**
	 * Delete all routing entries for all address families.
	 * 
	 * @param tid the transaction ID of this transaction.
	 */
	delete_all_entries ? tid:u32

	/**
	 * Delete all routing entries for the IPv4 address family.
	 * 
	 * @param tid the transaction ID of this transaction.
	 */
	delete_all_entries4 ? tid:u32

	/**
	 * Delete all routing entries for the IPv6 address family.
	 * 
	 * @param tid the transaction ID of this transaction.
	 */
	delete_all_entries6 ? tid:u32

	/**
	 * Lookup a route for a destination host address.
	 * 
	 * @param dst the destination host address to lookup.
	 * @param gateway the address of the next-hop router toward dst.
	 * @param ifname the name of the physical interface toward dst.
	 * @param vifname the name of the virtual interface toward dst.
	 * @param metric the routing metric toward dst.
	 * @param admin_distance the administratively defined distance
	 * toward dst.
	 * @param protocol_origin the name of the protocol that originated
	 * this entry.
	 */
	lookup_route4 ? dst:ipv4 -> netmask:ipv4net &			\
				    gateway:ipv4 &			\
				    ifname:txt &			\
				    vifname:txt &			\
				    metric:u32 &			\
				    admin_distance:u32 &		\
				    protocol_origin:txt

	/**
	 * Lookup a route for a destination host address.
	 * 
	 * @param dst the destination host address to lookup.
	 * @param gateway the address of the next-hop router toward dst.
	 * @param ifname the name of the physical interface toward dst.
	 * @param vifname the name of the virtual interface toward dst.
	 * @param metric the routing metric toward dst.
	 * @param admin_distance the administratively defined distance
	 * toward dst.
	 * @param protocol_origin the name of the protocol that originated
	 * this entry.
	 */
	lookup_route6 ? dst:ipv6 -> netmask:ipv6net &			\
				    gateway:ipv6 &			\
				    ifname:txt &			\
				    vifname:txt &			\
				    metric:u32 &			\
				    admin_distance:u32 &		\
				    protocol_origin:txt

	/**
	 * Lookup a route for a destination subnet address.
	 * 
	 * @param dst the destination subnet address to lookup.
	 * @param gateway the address of the next-hop router toward dst.
	 * @param ifname the name of the physical interface toward dst.
	 * @param vifname the name of the virtual interface toward dst.
	 * @param metric the routing metric toward dst.
	 * @param admin_distance the administratively defined distance
	 * toward dst.
	 * @param protocol_origin the name of the protocol that originated
	 * this entry.
	 */
	lookup_entry4 ?  dst:ipv4net					\
		      -> gateway:ipv4 &					\
		    	 ifname:txt &					\
			 vifname:txt &					\
			 metric:u32 &					\
			 admin_distance:u32 &				\
			 protocol_origin:txt

	/**
	 * Lookup a route for a destination subnet address.
	 * 
	 * @param dst the destination subnet address to lookup.
	 * @param gateway the address of the next-hop router toward dst.
	 * @param ifname the name of the physical interface toward dst.
	 * @param vifname the name of the virtual interface toward dst.
	 * @param metric the routing metric toward dst.
	 * @param admin_distance the administratively defined distance
	 * toward dst.
	 * @param protocol_origin the name of the protocol that originated
	 * this entry.
	 */
	lookup_entry6 ?  dst:ipv6net					\
		      -> gateway:ipv6 &					\
			 ifname:txt &					\
			 vifname:txt &					\
			 metric:u32 &					\
			 admin_distance:u32 &				\
			 protocol_origin:txt

	/*
	 * TBD: start_reading and read_entry forwarding table dump methods.
	 * Perhaps we request the forwarding table be dumped to file and then
	 * transfer the file.
	 */

	/**
	 * Test if the underlying system supports IPv4.
	 * 
	 * @param result true if the underlying system supports IPv4,
	 * otherwise false.
	 */
	have_ipv4 -> result:bool

	/**
	 * Test if the underlying system supports IPv6.
	 * 
	 * @param result true if the underlying system supports IPv4,
	 * otherwise false.
	 */
	have_ipv6 -> result:bool

	/**
	 * Test whether the IPv4 unicast forwarding engine is enabled
	 * or disabled to forward packets.
	 * 
	 * @param enabled if true, then the IPv4 unicast forwarding
	 * is enabled, otherwise is disabled.
	 */
	get_unicast_forwarding_enabled4 -> enabled:bool

	/**
	 * Test whether the IPv6 unicast forwarding engine is enabled
	 * or disabled to forward packets.
	 * 
	 * @param enabled if true, then the IPv6 unicast forwarding
	 * is enabled, otherwise is disabled.
	 */
	get_unicast_forwarding_enabled6 -> enabled:bool

	/**
	 * Set the IPv4 unicast forwarding engine to enable or disable
	 * forwarding of packets.
	 * 
	 * @param enabled if true, then enable IPv4 unicast forwarding,
	 * otherwise disable it.
	 */
	set_unicast_forwarding_enabled4 ? enabled:bool

	/**
	 * Set the IPv6 unicast forwarding engine to enable or disable
	 * forwarding of packets.
	 * 
	 * @param enabled if true, then enable IPv6 unicast forwarding,
	 * otherwise disable it.
	 */
	set_unicast_forwarding_enabled6 ? enabled:bool
}