sctp_bindx.3 (a47698f8d66e1eef4682e31d77b8f96c907461d5) sctp_bindx.3 (d8b5fd91b9011a1c21b7389e2dade6b9b1f6e425)
1.\" Copyright (c) 1983, 1991, 1993
2.\" The Regents of the University of California. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.

--- 29 unchanged lines hidden (view full) ---

38.Sh NAME
39.Nm sctp_bindx
40.Nd bind or unbind an SCTP socket to a list of addresses.
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.In sys/types.h
45.In sys/socket.h
1.\" Copyright (c) 1983, 1991, 1993
2.\" The Regents of the University of California. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.

--- 29 unchanged lines hidden (view full) ---

38.Sh NAME
39.Nm sctp_bindx
40.Nd bind or unbind an SCTP socket to a list of addresses.
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.In sys/types.h
45.In sys/socket.h
46.In netinet/sctp.h
46.In sys/sctp.h
47.Ft int
48.Fn sctp_bindx "int s" "struct sockaddr *addrs" "int num" "int type"
49.Sh DESCRIPTION
50The
51.Fn sctp_bindx
52call binds or unbinds a address or a list of addresses to an
47.Ft int
48.Fn sctp_bindx "int s" "struct sockaddr *addrs" "int num" "int type"
49.Sh DESCRIPTION
50The
51.Fn sctp_bindx
52call binds or unbinds a address or a list of addresses to an
53SCTP endpoint.
54This allows a user to bind a subset of
55addresses.
56The
53SCTP endpoint. This allows a user to bind a subset of
54addresses. The
57.Fn sctp_bindx
58call operates similarly to
59.Fn bind
60but allows a list of addresses and also allows a bind or an
55.Fn sctp_bindx
56call operates similarly to
57.Fn bind
58but allows a list of addresses and also allows a bind or an
61unbind.
62The argument
59unbind. The argument
63.Fa s
60.Fa s
64must be a valid SCTP socket descriptor.
65The argument
61must be a valid SCTP socket descriptor. The argument
66.Fa addrs
67is a list of addresses (where the list may be only 1 in
68length) that the user wishes to bind or unbind to the
62.Fa addrs
63is a list of addresses (where the list may be only 1 in
64length) that the user wishes to bind or unbind to the
69socket.
70The argument
65socket. The argument
71.Fa type
72must be one of the following values.
73.Pp
74.Dv SCTP_BINDX_ADD_ADDR
75This value indicates that the listed address(es) need to
76be added to the endpoint.
77.Pp
78.Dv SCTP_BINDX_DEL_ADDR
79This value indicates that the listed address(es) need to
80be removed from the endpoint.
81.Pp
82Note that when a user adds or deletes an address to an
66.Fa type
67must be one of the following values.
68.Pp
69.Dv SCTP_BINDX_ADD_ADDR
70This value indicates that the listed address(es) need to
71be added to the endpoint.
72.Pp
73.Dv SCTP_BINDX_DEL_ADDR
74This value indicates that the listed address(es) need to
75be removed from the endpoint.
76.Pp
77Note that when a user adds or deletes an address to an
83association if the dynamic address flag
84.Va net.inet.sctp.auto_asconf
78association if the dynamic address flag "net.inet.sctp.auto_asconf"
85is enabled any associations in the endpoint will attempt to
86have the address(es) added dynamically to the existing
87association.
88.Sh RETURN VALUES
89The call returns 0 on success and -1 upon failure.
90.Sh ERRORS
91The
92.Fn sctp_bindx
79is enabled any associations in the endpoint will attempt to
80have the address(es) added dynamically to the existing
81association.
82.Sh RETURN VALUES
83The call returns 0 on success and -1 upon failure.
84.Sh ERRORS
85The
86.Fn sctp_bindx
93function can return the following errors:
87can return the following errors.
94.Bl -tag -width Er
95.It Bq Er EINVAL
96This value is returned if the
97.Fa type
98field is not one of the allowed values (see above).
99.It Bq Er ENOMEM
100This value is returned if the number of addresses
101being added causes a memory allocation failure in
102the call.
103.It Bq Er EBADF
104The argument
105.Fa s
106is not a valid descriptor.
107.It Bq Er ENOTSOCK
108The argument
109.Fa s
110is not a socket.
111.El
112.Sh SEE ALSO
88.Bl -tag -width Er
89.It Bq Er EINVAL
90This value is returned if the
91.Fa type
92field is not one of the allowed values (see above).
93.It Bq Er ENOMEM
94This value is returned if the number of addresses
95being added causes a memory allocation failure in
96the call.
97.It Bq Er EBADF
98The argument
99.Fa s
100is not a valid descriptor.
101.It Bq Er ENOTSOCK
102The argument
103.Fa s
104is not a socket.
105.El
106.Sh SEE ALSO
107.Xr sctp 4 ,
113.Xr bind 2 ,
108.Xr bind 2 ,
114.Xr sctp 4
109