| 1 | package SPVM::Sys::IO::Flock; | ||
| 2 | |||
| 3 | 1; | ||
| 4 | |||
| 5 | =head1 Name | ||
| 6 | |||
| 7 | SPVM::Sys::IO::Flock - struct flock in the C language | ||
| 8 | |||
| 9 | =head1 Description | ||
| 10 | |||
| 11 | Sys::IO::Flock class in L<SPVM> is the class for C<struct flock> in the C language. | ||
| 12 | |||
| 13 | =head1 Usage | ||
| 14 | |||
| 15 | use Sys::IO::Flock; | ||
| 16 | my $flock = Sys::IO::Flock->new; | ||
| 17 | |||
| 18 | =head1 Details | ||
| 19 | |||
| 20 | This is a pointer class. The pointer of the instance is set to a C<struct flock> object. | ||
| 21 | |||
| 22 | =head1 Class Methods | ||
| 23 | |||
| 24 | =head2 new | ||
| 25 | |||
| 26 | C<native static method new : L<Sys::IO::Flock|SPVM::Sys::IO::Flock> ();> | ||
| 27 | |||
| 28 | Create a new C<Sys::IO::Flock> object. | ||
| 29 | |||
| 30 | =head1 Instance Methods | ||
| 31 | |||
| 32 | =head2 DESTROY | ||
| 33 | |||
| 34 | C<native method DESTROY : void ();> | ||
| 35 | |||
| 36 | The destructor. | ||
| 37 | |||
| 38 | =head2 l_type | ||
| 39 | |||
| 40 | C<native method l_type : int ();> | ||
| 41 | |||
| 42 | Returns C<l_type>. | ||
| 43 | |||
| 44 | =head2 set_l_type | ||
| 45 | |||
| 46 | C<native method set_l_type : void ($type : int);> | ||
| 47 | |||
| 48 | Sets C<l_type>. | ||
| 49 | |||
| 50 | =head2 l_whence | ||
| 51 | |||
| 52 | C<native method l_whence : int ();> | ||
| 53 | |||
| 54 | Returns C<l_whence>. | ||
| 55 | |||
| 56 | =head2 set_l_whence | ||
| 57 | |||
| 58 | C<native method set_l_whence : void ($whence : int);> | ||
| 59 | |||
| 60 | Sets C<l_whence>. | ||
| 61 | |||
| 62 | =head2 l_start | ||
| 63 | |||
| 64 | C<native method l_start : long ();> | ||
| 65 | |||
| 66 | Returns C<l_start>. | ||
| 67 | |||
| 68 | =head2 set_l_start | ||
| 69 | |||
| 70 | C<native method set_l_start : void ($start : long);> | ||
| 71 | |||
| 72 | Sets C<l_start>. | ||
| 73 | |||
| 74 | =head2 l_len | ||
| 75 | |||
| 76 | C<native method l_len : long ();> | ||
| 77 | |||
| 78 | Returns C<l_len>. | ||
| 79 | |||
| 80 | =head2 set_l_len | ||
| 81 | |||
| 82 | C<native method set_l_len : void ($len : long);> | ||
| 83 | |||
| 84 | Sets C<l_len>. | ||
| 85 | |||
| 86 | =head2 l_pid | ||
| 87 | |||
| 88 | C<native method l_pid : int ();> | ||
| 89 | |||
| 90 | Returns C<l_pid>. | ||
| 91 | |||
| 92 | =head2 set_l_pid | ||
| 93 | |||
| 94 | C<native method set_l_pid : void ($pid : int);> | ||
| 95 | |||
| 96 | Sets C<l_pid>. | ||
| 97 | |||
| 98 | =head1 See Also | ||
| 99 | |||
| 100 | =over 2 | ||
| 101 | |||
| 102 | =item * L<Sys|SPVM::Sys> | ||
| 103 | |||
| 104 | =back | ||
| 105 | |||
| 106 | =head1 Copyright & License | ||
| 107 | |||
| 108 | Copyright (c) 2023 Yuki Kimoto | ||
| 109 | |||
| 110 | MIT License | ||
| 111 |