fea.xrls

xorp源码hg

 *
 *  @param tid the transaction ID to use for this transaction.
 */
finder://fea/redist_transaction6/0.1/start_transaction->tid:u32

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

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

/**
 *  Add/delete a routing entry.
 *
 *  @param tid the transaction ID of this transaction.
 *
 *  @param dst destination network.
 *
 *  @param nexthop nexthop router address.
 *
 *  @param ifname interface name associated with nexthop.
 *
 *  @param vifname virtual interface name with nexthop.
 *
 *  @param metric origin routing protocol metric for route.
 *
 *  @param admin_distance administrative distance of origin routing protocol.
 *
 *  @param cookie value set by the requestor to identify redistribution source.
 *  Typical value is the originating protocol name.
 *
 *  @param protocol_origin the name of the protocol that originated this
 *  routing entry.
 */
finder://fea/redist_transaction6/0.1/add_route?tid:u32&dst:ipv6net&nexthop:ipv6&ifname:txt&vifname:txt&metric:u32&admin_distance:u32&cookie:txt&protocol_origin:txt

finder://fea/redist_transaction6/0.1/delete_route?tid:u32&dst:ipv6net&nexthop:ipv6&ifname:txt&vifname:txt&metric:u32&admin_distance:u32&cookie:txt&protocol_origin:txt

/**
 *  Delete all routing entries.
 *
 *  @param tid the transaction ID of this transaction.
 *
 *  @param cookie value set by the requestor to identify redistribution source.
 *  Typical value is the originating protocol name.
 */
finder://fea/redist_transaction6/0.1/delete_all_routes?tid:u32&cookie:txt

/**
 *  Send an IPv4 packet on a raw socket.
 *
 *  @param if_name the interface to send the packet on. It is essential for
 *  multicast. In the unicast case this field may be empty.
 *
 *  @param vif_name the vif to send the packet on. It is essential for
 *  multicast. In the unicast case this field may be empty.
 *
 *  @param src_address the IP source address.
 *
 *  @param dst_address the IP destination address.
 *
 *  @param ip_protocol the IP protocol number. It must be between 1 and 255.
 *
 *  @param ip_ttl the IP TTL (hop-limit). If it has a negative value, the TTL
 *  will be set internally before transmission.
 *
 *  @param ip_tos the Type Of Service (Diffserv/ECN bits for IPv4). If it has a
 *  negative value, the TOS will be set internally before transmission.
 *
 *  @param ip_router_alert if true, then add the IP Router Alert option to the
 *  IP packet.
 *
 *  @param payload the payload, everything after the IP header and options.
 */
finder://fea/raw_packet4/0.1/send?if_name:txt&vif_name:txt&src_address:ipv4&dst_address:ipv4&ip_protocol:u32&ip_ttl:i32&ip_tos:i32&ip_router_alert:bool&payload:binary

/**
 *  Register to receive IPv4 packets. The receiver is expected to support
 *  raw_packet4_client/0.1 interface.
 *
 *  @param xrl_target_name the receiver's XRL target name.
 *
 *  @param if_name the interface through which packets should be accepted.
 *
 *  @param vif_name the vif through which packets should be accepted.
 *
 *  @param ip_protocol the IP protocol number that the receiver is interested
 *  in. It must be between 0 and 255. A protocol number of 0 is used to specify
 *  all protocols.
 *
 *  @param enable_multicast_loopback if true then enable delivering of
 *  multicast datagrams back to this host (assuming the host is a member of the
 *  same multicast group.
 */
finder://fea/raw_packet4/0.1/register_receiver?xrl_target_name:txt&if_name:txt&vif_name:txt&ip_protocol:u32&enable_multicast_loopback:bool

/**
 *  Unregister to receive IPv4 packets.
 *
 *  @param xrl_target_name the receiver's XRL target name.
 *
 *  @param if_name the interface through which packets should not be accepted.
 *
 *  @param vif_name the vif through which packets should not be accepted.
 *
 *  @param ip_protocol the IP Protocol number that the receiver is not
 *  interested in anymore. It must be between 0 and 255. A protocol number of 0
 *  is used to specify all protocols.
 */
finder://fea/raw_packet4/0.1/unregister_receiver?xrl_target_name:txt&if_name:txt&vif_name:txt&ip_protocol:u32

/**
 *  Join an IPv4 multicast group.
 *
 *  @param xrl_target_name the receiver's XRL target name.
 *
 *  @param if_name the interface through which packets should be accepted.
 *
 *  @param vif_name the vif through which packets should be accepted.
 *
 *  @param ip_protocol the IP protocol number that the receiver is interested
 *  in. It must be between 0 and 255. A protocol number of 0 is used to specify
 *  all protocols.
 *
 *  @param group_address the multicast group address to join.
 */
finder://fea/raw_packet4/0.1/join_multicast_group?xrl_target_name:txt&if_name:txt&vif_name:txt&ip_protocol:u32&group_address:ipv4

/**
 *  Leave an IPv4 multicast group.
 *
 *  @param xrl_target_name the receiver's XRL target name.
 *
 *  @param if_name the interface through which packets should not be accepted.
 *
 *  @param vif_name the vif through which packets should not be accepted.
 *
 *  @param ip_protocol the IP protocol number that the receiver is not
 *  interested in anymore. It must be between 0 and 255. A protocol number of 0
 *  is used to specify all protocols.
 *
 *  @param group_address the multicast group address to leave.
 */
finder://fea/raw_packet4/0.1/leave_multicast_group?xrl_target_name:txt&if_name:txt&vif_name:txt&ip_protocol:u32&group_address:ipv4

/**
 *  Send an IPv6 packet on a raw socket.
 *
 *  @param if_name the interface to send the packet on. It is essential for
 *  multicast. In the unicast case this field may be empty.
 *
 *  @param vif_name the vif to send the packet on. It is essential for
 *  multicast. In the unicast case this field may be empty.
 *
 *  @param src_address the IP source address.
 *
 *  @param dst_address the IP destination address.
 *
 *  @param ip_protocol the IP protocol number. It must be between 1 and 255.
 *
 *  @param ip_ttl the IP TTL (hop-limit). If it has a negative value, the TTL
 *  will be set internally before transmission.
 *
 *  @param ip_tos the Type Of Service (IP traffic class for IPv6). If it has a
 *  negative value, the TOS will be set internally before transmission.
 *
 *  @param ip_router_alert if true, then add the IP Router Alert option to the
 *  IP packet.
 *
 *  @param ext_headers_type a list of u32 integers with the types of the
 *  optional extention headers.
 *
 *  @param ext_headers_payload a list of payload data, one for each optional
 *  extention header. The number of entries must match ext_headers_type.
 *
 *  @param payload the payload, everything after the IP header and options.
 */
finder://fea/raw_packet6/0.1/send?if_name:txt&vif_name:txt&src_address:ipv6&dst_address:ipv6&ip_protocol:u32&ip_ttl:i32&ip_tos:i32&ip_router_alert:bool&ext_headers_type:list&ext_headers_payload:list&payload:binary

/**
 *  Register to receive IPv6 packets. The receiver is expected to support
 *  raw_packet6_client/0.1 interface.
 *
 *  @param xrl_target_name the receiver's XRL target name.
 *
 *  @param if_name the interface through which packets should be accepted.
 *
 *  @param vif_name the vif through which packets should be accepted.
 *
 *  @param ip_protocol the IP protocol number that the receiver is interested
 *  in. It must be between 0 and 255. A protocol number of 0 is used to specify
 *  all protocols.
 *
 *  @param enable_multicast_loopback if true then enable delivering of
 *  multicast datagrams back to this host (assuming the host is a member of the
 *  same multicast group.
 */
finder://fea/raw_packet6/0.1/register_receiver?xrl_target_name:txt&if_name:txt&vif_name:txt&ip_protocol:u32&enable_multicast_loopback:bool

/**
 *  Unregister to receive IPv6 packets.
 *
 *  @param xrl_target_name the receiver's XRL target name.
 *
 *  @param if_name the interface through which packets should not be accepted.
 *
 *  @param vif_name the vif through which packets should not be accepted.
 *
 *  @param ip_protocol the IP Protocol number that the receiver is not
 *  interested in anymore. It must be between 0 and 255. A protocol number of 0
 *  is used to specify all protocols.
 */
finder://fea/raw_packet6/0.1/unregister_receiver?xrl_target_name:txt&if_name:txt&vif_name:txt&ip_protocol:u32

/**
 *  Join an IPv6 multicast group.
 *
 *  @param xrl_target_name the receiver's XRL target name.
 *
 *  @param if_name the interface through which packets should be accepted.
 *
 *  @param vif_name the vif through which packets should be accepted.
 *
 *  @param ip_protocol the IP protocol number that the receiver is interested
 *  in. It must be between 0 and 255. A protocol number of 0 is used to specify
 *  all protocols.
 *
 *  @param group_address the multicast group address to join.
 */
finder://fea/raw_packet6/0.1/join_multicast_group?xrl_target_name:txt&if_name:txt&vif_name:txt&ip_protocol:u32&group_address:ipv6

/**
 *  Leave an IPv6 multicast group.
 *
 *  @param xrl_target_name the receiver's XRL target name.
 *
 *  @param if_name the interface through which packets should not be accepted.
 *
 *  @param vif_name the vif through which packets should not be accepted.
 *
 *  @param ip_protocol the IP protocol number that the receiver is not
 *  interested in anymore. It must be between 0 and 255. A protocol number of 0
 *  is used to specify all protocols.
 *
 *  @param group_address the multicast group address to leave.
 */
finder://fea/raw_packet6/0.1/leave_multicast_group?xrl_target_name:txt&if_name:txt&vif_name:txt&ip_protocol:u32&group_address:ipv6

/**
 *  Find suitable socket serving Xrl Target for a particular interface address.
 */
finder://fea/socket4_locator/0.1/find_socket_server_for_addr?local_addr:ipv4->xrl_target:txt

/**
 *  Find suitable socket serving Xrl Target for a particular interface address.
 */
finder://fea/socket6_locator/0.1/find_socket_server_for_addr?local_addr:ipv6->xrl_target:txt

/**
 *  Enable profiling
 *
 *  @param pname profile variable
 */
finder://fea/profile/0.1/enable?pname:txt

/**
 *  Disable profiling
 *
 *  @param pname profile variable
 */
finder://fea/profile/0.1/disable?pname:txt

/**
 *  Get log entries.
 *
 *  @param pname profile variable
 *
 *  @param instance_name to send the profiling info to.
 */
finder://fea/profile/0.1/get_entries?pname:txt&instance_name:txt

/**
 *  Clear the profiling entries
 *
 *  @param pname profile variable
 */
finder://fea/profile/0.1/clear?pname:txt

/**
 *  List all the profiling variables registered with this target.
 */
finder://fea/profile/0.1/list->info:txt