|
| ||||||||||||||||
| XrlSocket4V0p1Client (XrlSender* s)
| XrlSocket4V0p1Client |
| ~XrlSocket4V0p1Client ()
| ~XrlSocket4V0p1Client |
[virtual]
| typedef XorpCallback2<void, const XrlError&, const string*>::RefPtr TcpOpenAndBindCB | TcpOpenAndBindCB |
| bool send_tcp_open_and_bind (
const char* target_name,
const string& creator,
const IPv4& local_addr,
const uint32_t& local_port,
const bool& is_blocking,
const TcpOpenAndBindCB& cb
)
| send_tcp_open_and_bind |
Send Xrl intended to:
Create a bound TCP socket.
Parameters:
| tgt_name | Xrl Target name |
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket4_user/0.1. |
| local_addr | the interface address to bind socket to. |
| local_port | the port to bind socket to. |
| is_blocking | if true then the socket will be blocking, otherwise non-blocking. |
| typedef XorpCallback2<void, const XrlError&, const string*>::RefPtr UdpOpenAndBindCB | UdpOpenAndBindCB |
| bool send_udp_open_and_bind (
const char* target_name,
const string& creator,
const IPv4& local_addr,
const uint32_t& local_port,
const bool& is_blocking,
const UdpOpenAndBindCB& cb
)
| send_udp_open_and_bind |
Send Xrl intended to:
Create a bound UDP socket.
Parameters:
| tgt_name | Xrl Target name |
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket4_user/0.1. |
| local_addr | the interface address to bind socket to. |
| local_port | the port to bind socket to. |
| is_blocking | if true then the socket will be blocking, otherwise non-blocking. |
| typedef XorpCallback2<void, const XrlError&, const string*>::RefPtr UdpOpenBindJoinCB | UdpOpenBindJoinCB |
| bool send_udp_open_bind_join (
const char* target_name,
const string& creator,
const IPv4& local_addr,
const uint32_t& local_port,
const IPv4& mcast_addr,
const uint32_t& ttl,
const bool& reuse,
const bool& is_blocking,
const UdpOpenBindJoinCB& cb
)
| send_udp_open_bind_join |
Send Xrl intended to:
Create a bound UDP multicast socket.
Parameters:
| tgt_name | Xrl Target name |
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket4_user/0.1. |
| local_addr | the interface address to bind socket to. |
| local_port | the port to bind socket to. |
| mcast_addr | the multicast group address to join. |
| ttl | the ttl to use for this multicast socket. |
| reuse | allow other sockets to bind to same multicast group. |
| is_blocking | if true then the socket will be blocking, otherwise non-blocking. |
| typedef XorpCallback2<void, const XrlError&, const string*>::RefPtr TcpOpenBindConnectCB | TcpOpenBindConnectCB |
| bool send_tcp_open_bind_connect (
const char* target_name,
const string& creator,
const IPv4& local_addr,
const uint32_t& local_port,
const IPv4& remote_addr,
const uint32_t& remote_port,
const bool& is_blocking,
const TcpOpenBindConnectCB& cb
)
| send_tcp_open_bind_connect |
Send Xrl intended to:
Create a bound and connected TCP socket.
Parameters:
| tgt_name | Xrl Target name |
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket4_user/0.1. |
| local_addr | the interface address to bind socket to. |
| local_port | the port to bind socket to. |
| remote_addr | the address to connect to. |
| remote_port | the remote port to connect to. |
| is_blocking | if true then the socket will be blocking, otherwise non-blocking. |
| typedef XorpCallback2<void, const XrlError&, const string*>::RefPtr UdpOpenBindConnectCB | UdpOpenBindConnectCB |
| bool send_udp_open_bind_connect (
const char* target_name,
const string& creator,
const IPv4& local_addr,
const uint32_t& local_port,
const IPv4& remote_addr,
const uint32_t& remote_port,
const bool& is_blocking,
const UdpOpenBindConnectCB& cb
)
| send_udp_open_bind_connect |
Send Xrl intended to:
Create a bound and connected UDP socket.
Parameters:
| tgt_name | Xrl Target name |
| creator | the Xrl Target instance name of the socket creator. The named target must implement socket4_user/0.1. |
| local_addr | the interface address to bind socket to. |
| local_port | the port to bind socket to. |
| remote_addr | the address to connect to. |
| remote_port | the remote port to connect to. |
| is_blocking | if true then the socket will be blocking, otherwise non-blocking. |
| typedef XorpCallback1<void, const XrlError&>::RefPtr UdpJoinGroupCB | UdpJoinGroupCB |
| bool send_udp_join_group (
const char* target_name,
const string& sockid,
const IPv4& mcast_addr,
const IPv4& join_if_addr,
const UdpJoinGroupCB& cb
)
| send_udp_join_group |
Send Xrl intended to:
Join multicast group on already bound socket.
Parameters:
| tgt_name | Xrl Target name |
| sockid | unique socket id. |
| mcast_addr | group to join. |
| join_if_addr | interface address to perform join on. |
| typedef XorpCallback1<void, const XrlError&>::RefPtr UdpLeaveGroupCB | UdpLeaveGroupCB |
| bool send_udp_leave_group (
const char* target_name,
const string& sockid,
const IPv4& mcast_addr,
const IPv4& leave_if_addr,
const UdpLeaveGroupCB& cb
)
| send_udp_leave_group |
Send Xrl intended to:
Leave multicast group on already bound socket.
Parameters:
| tgt_name | Xrl Target name |
| sockid | unique socket id. |
| mcast_addr | group to leave. |
| leave_if_addr | interface address to perform leave on. |
| typedef XorpCallback1<void, const XrlError&>::RefPtr CloseCB | CloseCB |
| bool send_close (
const char* target_name,
const string& sockid,
const CloseCB& cb
)
| send_close |
Send Xrl intended to:
Close socket.
Parameters:
| tgt_name | Xrl Target name |
| sockid | unique socket id of socket to be closed. |
| typedef XorpCallback1<void, const XrlError&>::RefPtr TcpListenCB | TcpListenCB |
| bool send_tcp_listen (
const char* target_name,
const string& sockid,
const uint32_t& backlog,
const TcpListenCB& cb
)
| send_tcp_listen |
Send Xrl intended to:
Listen for inbound connections on socket. When a connection request received the socket creator will receive notification through socket4_user/0.1/connect_event.
Parameters:
| tgt_name | Xrl Target name |
| sockid | the unique socket id of the socket to perform listen. |
| backlog | the maximum number of pending connections. |
| typedef XorpCallback1<void, const XrlError&>::RefPtr SendCB | SendCB |
| bool send_send (
const char* target_name,
const string& sockid,
const vector<uint8_t>& data,
const SendCB& cb
)
| send_send |
Send Xrl intended to:
Send data on socket.
Parameters:
| tgt_name | Xrl Target name |
| sockid | unique socket id. |
| data | block of data to be sent. |
| typedef XorpCallback1<void, const XrlError&>::RefPtr SendWithFlagsCB | SendWithFlagsCB |
| bool send_send_with_flags (
const char* target_name,
const string& sockid,
const vector<uint8_t>& data,
const bool& out_of_band,
const bool& end_of_record,
const bool& end_of_file,
const SendWithFlagsCB& cb
)
| send_send_with_flags |
Send Xrl intended to:
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.
Parameters:
| tgt_name | Xrl Target name |
| sockid | unique socket id. |
| data | block of data to be sent. |
| out_of_band | mark data as out of band. |
| end_of_record | data completes record. |
| end_of_file | data completes file. |
| typedef XorpCallback1<void, const XrlError&>::RefPtr SendToCB | SendToCB |
| bool send_send_to (
const char* target_name,
const string& sockid,
const IPv4& remote_addr,
const uint32_t& remote_port,
const vector<uint8_t>& data,
const SendToCB& cb
)
| send_send_to |
Send Xrl intended to:
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.
Parameters:
| tgt_name | Xrl Target name |
| sockid | unique socket id. |
| remote_addr | destination address for data. |
| remote_port | destination port for data. |
| data | block of data to be sent. |
| typedef XorpCallback1<void, const XrlError&>::RefPtr SendToWithFlagsCB | SendToWithFlagsCB |
| bool send_send_to_with_flags (
const char* target_name,
const string& sockid,
const IPv4& remote_addr,
const uint32_t& remote_port,
const vector<uint8_t>& data,
const bool& out_of_band,
const bool& end_of_record,
const bool& end_of_file,
const SendToWithFlagsCB& cb
)
| send_send_to_with_flags |
Send Xrl intended to:
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.
Parameters:
| tgt_name | Xrl Target name |
| sockid | unique socket id. |
| remote_addr | destination address for data. |
| remote_port | destination port for data. |
| data | block of data to be sent. |
| out_of_band | mark data as out of band. |
| end_of_record | data completes record. |
| end_of_file | data completes file. |
| typedef XorpCallback1<void, const XrlError&>::RefPtr SendFromMulticastIfCB | SendFromMulticastIfCB |
| bool send_send_from_multicast_if (
const char* target_name,
const string& sockid,
const IPv4& group_addr,
const uint32_t& group_port,
const IPv4& ifaddr,
const vector<uint8_t>& data,
const SendFromMulticastIfCB& cb
)
| send_send_from_multicast_if |
Send Xrl intended to:
Send data on socket to a given multicast group from a given interface.
Parameters:
| tgt_name | Xrl Target name |
| sockid | unique socket id. |
| group_addr | destination address for data. |
| group_port | destination port for data. |
| ifaddr | interface address |
| typedef XorpCallback1<void, const XrlError&>::RefPtr SetSocketOptionCB | SetSocketOptionCB |
| bool send_set_socket_option (
const char* target_name,
const string& sockid,
const string& optname,
const uint32_t& optval,
const SetSocketOptionCB& cb
)
| send_set_socket_option |
Send Xrl intended to:
Set a named socket option.
Parameters:
| tgt_name | Xrl Target name |
| sockid | unique socket id. |
| optname | name of option to be set. Valid values are: "multicast_loopback" "multicast_ttl" |
| optval | value of option to be set. If value is logically boolean then zero represents false and any non-zero value true. |
| typedef XorpCallback2<void, const XrlError&, const uint32_t*>::RefPtr GetSocketOptionCB | GetSocketOptionCB |
| bool send_get_socket_option (
const char* target_name,
const string& sockid,
const string& optname,
const GetSocketOptionCB& cb
)
| send_get_socket_option |
Send Xrl intended to:
Get a named socket option.
Parameters:
| tgt_name | Xrl Target name |
| sockid | unique socket id. |
| optname | name of option to be set. Valid values are documented in set_socket_option. |
| XrlSender* _sender | _sender |
[protected]
