| 1 | package SPVM::Sys::Socket::Ip_mreq; | ||
| 2 | |||
| 3 | 1; | ||
| 4 | |||
| 5 | =head1 Name | ||
| 6 | |||
| 7 | SPVM::Sys::Socket::Ip_mreq - struct ip_mreq in the C language | ||
| 8 | |||
| 9 | =head1 Description | ||
| 10 | |||
| 11 | Sys::Socket::In_addr class in L<SPVM> represents L<struct ip_mreq|https://linux.die.net/man/7/ip> in the C language. | ||
| 12 | |||
| 13 | =head1 Usage | ||
| 14 | |||
| 15 | use Sys::Socket::Ip_mreq; | ||
| 16 | |||
| 17 | =head1 Details | ||
| 18 | |||
| 19 | This class is a pointer class. The pointer the instance has is set to a L<struct ip_mreq|https://linux.die.net/man/7/ip> object. | ||
| 20 | |||
| 21 | C<struct ip_mreq> is the old format of C<struct ip_mreqn>. | ||
| 22 | |||
| 23 | =head1 Class Methods | ||
| 24 | |||
| 25 | =head2 new | ||
| 26 | |||
| 27 | C<static method new : L<Sys::Socket::Ip_mreq|SPVM::Sys::Socket::Ip_mreq> ();> | ||
| 28 | |||
| 29 | Create a new L<Sys::Socket::Ip_mreq|SPVM::Sys::Socket::Ip_mreq> object. | ||
| 30 | |||
| 31 | =head1 Instance Methods | ||
| 32 | |||
| 33 | =head2 DESTROY | ||
| 34 | |||
| 35 | C<method DESTROY : void ();> | ||
| 36 | |||
| 37 | The destructor. | ||
| 38 | |||
| 39 | =head2 imr_multiaddr | ||
| 40 | |||
| 41 | C<method imr_multiaddr : L<Sys::Socket::In_addr|SPVM::Sys::Socket::In_addr> ();> | ||
| 42 | |||
| 43 | Copies C<imr_multiaddr> and returns it. | ||
| 44 | |||
| 45 | =head2 set_imr_multiaddr | ||
| 46 | |||
| 47 | C<method set_imr_multiaddr : void ($address : L<Sys::Socket::In_addr|SPVM::Sys::Socket::In_addr>);> | ||
| 48 | |||
| 49 | Sets C<imr_multiaddr>. | ||
| 50 | |||
| 51 | =head2 imr_interface | ||
| 52 | |||
| 53 | C<method imr_interface : L<Sys::Socket::In_addr|SPVM::Sys::Socket::In_addr> ();> | ||
| 54 | |||
| 55 | Copies C<imr_interface> and returns it. | ||
| 56 | |||
| 57 | =head2 set_imr_interface | ||
| 58 | |||
| 59 | C<method set_imr_interface : void ($interface : L<Sys::Socket::In_addr|SPVM::Sys::Socket::In_addr>);> | ||
| 60 | |||
| 61 | Sets C<imr_interface>. | ||
| 62 | |||
| 63 | =head1 See Also | ||
| 64 | |||
| 65 | =over 2 | ||
| 66 | |||
| 67 | =item * L<Sys|SPVM::Sys> | ||
| 68 | |||
| 69 | =back | ||
| 70 | |||
| 71 | =head1 Copyright & License | ||
| 72 | |||
| 73 | Copyright (c) 2023 Yuki Kimoto | ||
| 74 | |||
| 75 | MIT License | ||
| 76 |