socket_server.xrls

xorp源码hg

/*
 * Copyright (c) 2001-2007 International Computer Science Institute
 * See LICENSE file for licensing, conditions, and warranties on use.
 *
 * DO NOT EDIT THIS FILE - IT IS PROGRAMMATICALLY GENERATED
 *
 * Generated by 'tgt-gen'.
 *
 * $XORP: xorp/xrl/targets/socket_server.xrls,v 1.9 2007/02/16 22:47:57 pavlin Exp $
 */

/**
 *  Get name of Xrl Target
 */
finder://socket_server/common/0.1/get_target_name->name:txt

/**
 *  Get version string from Xrl Target
 */
finder://socket_server/common/0.1/get_version->version:txt

/**
 *  Get status of Xrl Target
 */
finder://socket_server/common/0.1/get_status->status:u32&reason:txt

/**
 *  Request clean shutdown of Xrl Target
 */
finder://socket_server/common/0.1/shutdown

/**
 *  Announce target birth to observer.
 *
 *  @param target_class the target class name.
 *
 *  @param target_instance the target instance name.
 */
finder://socket_server/finder_event_observer/0.1/xrl_target_birth?target_class:txt&target_instance:txt

/**
 *  Announce target death to observer.
 *
 *  @param target_class the target class name.
 *
 *  @param target_instance the target instance name.
 */
finder://socket_server/finder_event_observer/0.1/xrl_target_death?target_class:txt&target_instance:txt

/**
 *  Create a bound TCP socket.
 *
 *  @param creator the Xrl Target instance name of the socket creator. The
 *  named target must implement socket4_user/0.1.
 *
 *  @param local_addr the interface address to bind socket to.
 *
 *  @param local_port the port to bind socket to.
 *
 *  @param is_blocking if true then the socket will be blocking, otherwise
 *  non-blocking.
 *
 *  @param sockid return parameter that contains unique socket id when socket
 *  instantiation is successful.
 */
finder://socket_server/socket4/0.1/tcp_open_and_bind?creator:txt&local_addr:ipv4&local_port:u32&is_blocking:bool->sockid:txt

/**
 *  Create a bound UDP socket.
 *
 *  @param creator the Xrl Target instance name of the socket creator. The
 *  named target must implement socket4_user/0.1.
 *
 *  @param local_addr the interface address to bind socket to.
 *
 *  @param local_port the port to bind socket to.
 *
 *  @param is_blocking if true then the socket will be blocking, otherwise
 *  non-blocking.
 *
 *  @param sockid return parameter that contains unique socket id when socket
 *  instantiation is successful.
 */
finder://socket_server/socket4/0.1/udp_open_and_bind?creator:txt&local_addr:ipv4&local_port:u32&is_blocking:bool->sockid:txt

/**
 *  Create a bound UDP multicast socket.
 *
 *  @param creator the Xrl Target instance name of the socket creator. The
 *  named target must implement socket4_user/0.1.
 *
 *  @param local_addr the interface address to bind socket to.
 *
 *  @param local_port the port to bind socket to.
 *
 *  @param mcast_addr the multicast group address to join.
 *
 *  @param ttl the ttl to use for this multicast socket.
 *
 *  @param reuse allow other sockets to bind to same multicast group.
 *
 *  @param is_blocking if true then the socket will be blocking, otherwise
 *  non-blocking.
 *
 *  @param sockid return parameter that contains unique socket id when socket
 *  instantiation is successful.
 */
finder://socket_server/socket4/0.1/udp_open_bind_join?creator:txt&local_addr:ipv4&local_port:u32&mcast_addr:ipv4&ttl:u32&reuse:bool&is_blocking:bool->sockid:txt

/**
 *  Create a bound and connected TCP socket.
 *
 *  @param creator the Xrl Target instance name of the socket creator. The
 *  named target must implement socket4_user/0.1.
 *
 *  @param local_addr the interface address to bind socket to.
 *
 *  @param local_port the port to bind socket to.
 *
 *  @param remote_addr the address to connect to.
 *
 *  @param remote_port the remote port to connect to.
 *
 *  @param is_blocking if true then the socket will be blocking, otherwise
 *  non-blocking.
 *
 *  @param sockid return parameter that contains unique socket id when socket
 *  instantiation is successful.
 */
finder://socket_server/socket4/0.1/tcp_open_bind_connect?creator:txt&local_addr:ipv4&local_port:u32&remote_addr:ipv4&remote_port:u32&is_blocking:bool->sockid:txt

/**
 *  Create a bound and connected UDP socket.
 *
 *  @param creator the Xrl Target instance name of the socket creator. The
 *  named target must implement socket4_user/0.1.
 *
 *  @param local_addr the interface address to bind socket to.
 *
 *  @param local_port the port to bind socket to.
 *
 *  @param remote_addr the address to connect to.
 *
 *  @param remote_port the remote port to connect to.
 *
 *  @param is_blocking if true then the socket will be blocking, otherwise
 *  non-blocking.
 *
 *  @param sockid return parameter that contains unique socket id when socket
 *  instantiation is successful.
 */
finder://socket_server/socket4/0.1/udp_open_bind_connect?creator:txt&local_addr:ipv4&local_port:u32&remote_addr:ipv4&remote_port:u32&is_blocking:bool->sockid:txt

/**
 *  Join multicast group on already bound socket.
 *
 *  @param sockid unique socket id.
 *
 *  @param mcast_addr group to join.
 *
 *  @param join_if_addr interface address to perform join on.
 */
finder://socket_server/socket4/0.1/udp_join_group?sockid:txt&mcast_addr:ipv4&join_if_addr:ipv4

/**
 *  Leave multicast group on already bound socket.
 *
 *  @param sockid unique socket id.
 *
 *  @param mcast_addr group to leave.
 *
 *  @param leave_if_addr interface address to perform leave on.
 */
finder://socket_server/socket4/0.1/udp_leave_group?sockid:txt&mcast_addr:ipv4&leave_if_addr:ipv4

/**
 *  Close socket.
 *
 *  @param sockid unique socket id of socket to be closed.
 */
finder://socket_server/socket4/0.1/close?sockid:txt

/**
 *  Listen for inbound connections on socket. When a connection request
 *  received the socket creator will receive notification through
 *  socket4_user/0.1/connect_event.
 *
 *  @param sockid the unique socket id of the socket to perform listen.
 *
 *  @param backlog the maximum number of pending connections.
 */
finder://socket_server/socket4/0.1/tcp_listen?sockid:txt&backlog:u32

/**
 *  Send data on socket.
 *
 *  @param sockid unique socket id.
 *
 *  @param data block of data to be sent.
 */
finder://socket_server/socket4/0.1/send?sockid:txt&data:binary

/**
 *  Send data on socket with optional flags. These flags provide hints to the
 *  forwarding engine on how to send the packets, they are not guaranteed to
 *  work. NB: There is no flag for "do not route" as this is always true since
 *  the particular forwarding engine sending the data may not have access to
 *  the full routing table.
 *
 *  @param sockid unique socket id.
 *
 *  @param data block of data to be sent.
 *
 *  @param out_of_band mark data as out of band.
 *
 *  @param end_of_record data completes record.
 *
 *  @param end_of_file data completes file.
 */
finder://socket_server/socket4/0.1/send_with_flags?sockid:txt&data:binary&out_of_band:bool&end_of_record:bool&end_of_file:bool

/**
 *  Send data on socket to a given destination. The packet is not routed as the
 *  forwarding engine sending the packet may not have access to the full
 *  routing table.
 *
 *  @param sockid unique socket id.
 *
 *  @param remote_addr destination address for data.
 *
 *  @param remote_port destination port for data.
 *
 *  @param data block of data to be sent.
 */
finder://socket_server/socket4/0.1/send_to?sockid:txt&remote_addr:ipv4&remote_port:u32&data:binary

/**
 *  Send data on socket to a given destination. The packet is not routed as the
 *  forwarding engine sending the packet may not have access to the full
 *  routing table.
 *
 *  @param sockid unique socket id.
 *
 *  @param remote_addr destination address for data.
 *
 *  @param remote_port destination port for data.
 *
 *  @param data block of data to be sent.
 *
 *  @param out_of_band mark data as out of band.
 *
 *  @param end_of_record data completes record.
 *
 *  @param end_of_file data completes file.
 */
finder://socket_server/socket4/0.1/send_to_with_flags?sockid:txt&remote_addr:ipv4&remote_port:u32&data:binary&out_of_band:bool&end_of_record:bool&end_of_file:bool

/**
 *  Send data on socket to a given multicast group from a given interface.
 *
 *  @param sockid unique socket id.
 *
 *  @param group_addr destination address for data.
 *
 *  @param group_port destination port for data.
 *
 *  @param ifaddr interface address
 */
finder://socket_server/socket4/0.1/send_from_multicast_if?sockid:txt&group_addr:ipv4&group_port:u32&ifaddr:ipv4&data:binary

/**
 *  Set a named socket option.