Blame doc/modules/posix.sys.msg.html

Packit 437b5e
Packit 437b5e
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
Packit 437b5e
<html>
Packit 437b5e
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
Packit 437b5e
<head>
Packit 437b5e
    <title>luaposix 33.3.0 Reference</title>
Packit 437b5e
    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
Packit 437b5e
</head>
Packit 437b5e
<body>
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
	
Packit 437b5e
	
<big></big>
Packit 437b5e
	
Packit 437b5e
 
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e
Packit 437b5e

Packit 437b5e

luaposix 33.3.0

Packit 437b5e
Packit 437b5e
    Packit 437b5e
      
  • Index
  • Packit 437b5e
    Packit 437b5e
    Packit 437b5e

    Contents

    Packit 437b5e
      Packit 437b5e
    • Functions
    • Packit 437b5e
    • Constants
    • Packit 437b5e
      Packit 437b5e
      Packit 437b5e
      Packit 437b5e

      Modules

      Packit 437b5e
        Packit 437b5e
          
      • posix
      • Packit 437b5e
          
      • posix.ctype
      • Packit 437b5e
          
      • posix.curses
      • Packit 437b5e
          
      • posix.dirent
      • Packit 437b5e
          
      • posix.errno
      • Packit 437b5e
          
      • posix.fcntl
      • Packit 437b5e
          
      • posix.fnmatch
      • Packit 437b5e
          
      • posix.getopt
      • Packit 437b5e
          
      • posix.glob
      • Packit 437b5e
          
      • posix.grp
      • Packit 437b5e
          
      • posix.libgen
      • Packit 437b5e
          
      • posix.poll
      • Packit 437b5e
          
      • posix.pwd
      • Packit 437b5e
          
      • posix.sched
      • Packit 437b5e
          
      • posix.signal
      • Packit 437b5e
          
      • posix.stdio
      • Packit 437b5e
          
      • posix.stdlib
      • Packit 437b5e
          
      • posix.sys.msg
      • Packit 437b5e
          
      • posix.sys.resource
      • Packit 437b5e
          
      • posix.sys.socket
      • Packit 437b5e
          
      • posix.sys.stat
      • Packit 437b5e
          
      • posix.sys.statvfs
      • Packit 437b5e
          
      • posix.sys.time
      • Packit 437b5e
          
      • posix.sys.times
      • Packit 437b5e
          
      • posix.sys.utsname
      • Packit 437b5e
          
      • posix.sys.wait
      • Packit 437b5e
          
      • posix.syslog
      • Packit 437b5e
          
      • posix.termio
      • Packit 437b5e
          
      • posix.time
      • Packit 437b5e
          
      • posix.unistd
      • Packit 437b5e
          
      • posix.utime
      • Packit 437b5e
        Packit 437b5e

        Classes

        Packit 437b5e
          Packit 437b5e
            
        • posix.curses.chstr
        • Packit 437b5e
            
        • posix.curses.window
        • Packit 437b5e
          Packit 437b5e

          Examples

          Packit 437b5e
            Packit 437b5e
              
          • curses.lua
          • Packit 437b5e
              
          • dir.lua
          • Packit 437b5e
              
          • fork.lua
          • Packit 437b5e
              
          • fork2.lua
          • Packit 437b5e
              
          • getopt.lua
          • Packit 437b5e
              
          • glob.lua
          • Packit 437b5e
              
          • limit.lua
          • Packit 437b5e
              
          • lock.lua
          • Packit 437b5e
              
          • netlink-uevent.lua
          • Packit 437b5e
              
          • ping.lua
          • Packit 437b5e
              
          • poll.lua
          • Packit 437b5e
              
          • rt_sched.lua
          • Packit 437b5e
              
          • signal.lua
          • Packit 437b5e
              
          • socket.lua
          • Packit 437b5e
              
          • termios.lua
          • Packit 437b5e
              
          • tree.lua
          • Packit 437b5e
            Packit 437b5e
            Packit 437b5e
            Packit 437b5e
            Packit 437b5e
            Packit 437b5e
            Packit 437b5e

            Module posix.sys.msg

            Packit 437b5e

            Sys V Message Queue Operations.

            Packit 437b5e

            Where supported by the underlying system, functions to send and receive

            Packit 437b5e
             interprocess messages.  If the module loads successfully, but there is
            Packit 437b5e
             no system support, then posix.sys.msg.version will be set, but the
            Packit 437b5e
             unsupported APIs wil be nil.

            Packit 437b5e
            Packit 437b5e
            Packit 437b5e

            Functions

            Packit 437b5e
            Packit 437b5e
            	
            Packit 437b5e
            	msgget (key[, flags=0])
            Packit 437b5e
            	Get a message queue identifier
            Packit 437b5e
            	
            Packit 437b5e
            	
            Packit 437b5e
            	msgrcv (id, size, type[, flags=0])
            Packit 437b5e
            	Receive message from a message queue
            Packit 437b5e
            	
            Packit 437b5e
            	
            Packit 437b5e
            	msgsnd (id, type, message[, flags=0])
            Packit 437b5e
            	Send message to a message queue
            Packit 437b5e
            	
            Packit 437b5e
            Packit 437b5e

            Constants

            Packit 437b5e
            Packit 437b5e
            	
            Packit 437b5e
            	posix.sys.msg
            Packit 437b5e
            	Message constants.
            Packit 437b5e
            	
            Packit 437b5e
            Packit 437b5e
            Packit 437b5e

            Packit 437b5e

            Packit 437b5e
            Packit 437b5e
            Packit 437b5e
                

            Functions

            Packit 437b5e
            Packit 437b5e
                
            Packit 437b5e
                
            Packit 437b5e
                
            Packit 437b5e
                msgget (key[, flags=0])
            Packit 437b5e
                
            Packit 437b5e
                
            Packit 437b5e
                Get a message queue identifier
            Packit 437b5e
            Packit 437b5e
            Packit 437b5e
                

            Parameters:

            Packit 437b5e
                
              Packit 437b5e
                      
            • key
            • Packit 437b5e
                          int
              Packit 437b5e
                       message queue id, or IPC_PRIVATE for a new queue
              Packit 437b5e
                      
              Packit 437b5e
                      
            • flags
            • Packit 437b5e
                          int
              Packit 437b5e
                       bitwise OR of zero or more from IPC_CREAT and IPC_EXCL,
              Packit 437b5e
                and access permissions S_IRUSR, S_IWUSR, S_IRGRP, S_IWGRP, S_IROTH
              Packit 437b5e
                and S_IWOTH (from posix.sys.stat)
              Packit 437b5e
                       (default 0)
              Packit 437b5e
                      
              Packit 437b5e
                  
              Packit 437b5e
              Packit 437b5e
                  

              Returns:

              Packit 437b5e
                  
                Packit 437b5e
                Packit 437b5e
                           int
                Packit 437b5e
                        message queue identifier, if successful
                Packit 437b5e
                    
                Packit 437b5e
                     

                Or

                Packit 437b5e
                    
                  Packit 437b5e
                          
                1. Packit 437b5e
                          nil
                  Packit 437b5e
                          
                2. Packit 437b5e
                             string
                  Packit 437b5e
                          error message
                  Packit 437b5e
                          
                3. Packit 437b5e
                             int
                  Packit 437b5e
                          errnum
                  Packit 437b5e
                      
                  Packit 437b5e
                  Packit 437b5e
                  Packit 437b5e
                      

                  See also:

                  Packit 437b5e
                      
                    Packit 437b5e
                             msgget(2)
                    Packit 437b5e
                        
                    Packit 437b5e
                    Packit 437b5e
                    Packit 437b5e
                    Packit 437b5e
                        
                    Packit 437b5e
                        
                    Packit 437b5e
                        msgrcv (id, size, type[, flags=0])
                    Packit 437b5e
                        
                    Packit 437b5e
                        
                    Packit 437b5e
                        Receive message from a message queue
                    Packit 437b5e
                    Packit 437b5e
                    Packit 437b5e
                        

                    Parameters:

                    Packit 437b5e
                        
                      Packit 437b5e
                              
                    • id
                    • Packit 437b5e
                                  int
                      Packit 437b5e
                               message queue identifier returned by msgget
                      Packit 437b5e
                              
                      Packit 437b5e
                              
                    • size
                    • Packit 437b5e
                                  int
                      Packit 437b5e
                               maximum message size
                      Packit 437b5e
                              
                      Packit 437b5e
                              
                    • type
                    • Packit 437b5e
                                  int
                      Packit 437b5e
                               message type (optional, default - 0)
                      Packit 437b5e
                              
                      Packit 437b5e
                              
                    • flags
                    • Packit 437b5e
                                  int
                      Packit 437b5e
                               bitwise OR of zero or more of IPC_NOWAIT, MSG_EXCEPT
                      Packit 437b5e
                        and MSG_NOERROR
                      Packit 437b5e
                               (default 0)
                      Packit 437b5e
                              
                      Packit 437b5e
                          
                      Packit 437b5e
                      Packit 437b5e
                          

                      Returns:

                      Packit 437b5e
                          
                        Packit 437b5e
                                
                      1. Packit 437b5e
                                   int
                        Packit 437b5e
                                message type from msgsnd
                        Packit 437b5e
                                
                      2. Packit 437b5e
                                   string
                        Packit 437b5e
                                message text, if successful
                        Packit 437b5e
                            
                        Packit 437b5e
                             

                        Or

                        Packit 437b5e
                            
                          Packit 437b5e
                                  
                        1. Packit 437b5e
                                  nil
                          Packit 437b5e
                                  
                        2. Packit 437b5e
                                     string
                          Packit 437b5e
                                  error message
                          Packit 437b5e
                                  
                        3. Packit 437b5e
                                     int
                          Packit 437b5e
                                  errnum
                          Packit 437b5e
                              
                          Packit 437b5e
                          Packit 437b5e
                          Packit 437b5e
                              

                          See also:

                          Packit 437b5e
                              
                            Packit 437b5e
                                     msgrcv(2)
                            Packit 437b5e
                                
                            Packit 437b5e
                            Packit 437b5e
                            Packit 437b5e
                            Packit 437b5e
                                
                            Packit 437b5e
                                
                            Packit 437b5e
                                msgsnd (id, type, message[, flags=0])
                            Packit 437b5e
                                
                            Packit 437b5e
                                
                            Packit 437b5e
                                Send message to a message queue
                            Packit 437b5e
                            Packit 437b5e
                            Packit 437b5e
                                

                            Parameters:

                            Packit 437b5e
                                
                              Packit 437b5e
                                      
                            • id
                            • Packit 437b5e
                                          int
                              Packit 437b5e
                                       message queue identifier returned by msgget
                              Packit 437b5e
                                      
                              Packit 437b5e
                                      
                            • type
                            • Packit 437b5e
                                          int
                              Packit 437b5e
                                       arbitrary message type
                              Packit 437b5e
                                      
                              Packit 437b5e
                                      
                            • message
                            • Packit 437b5e
                                          string
                              Packit 437b5e
                                       content
                              Packit 437b5e
                                      
                              Packit 437b5e
                                      
                            • flags
                            • Packit 437b5e
                                          int
                              Packit 437b5e
                                       optionally IPC_NOWAIT
                              Packit 437b5e
                                       (default 0)
                              Packit 437b5e
                                      
                              Packit 437b5e
                                  
                              Packit 437b5e
                              Packit 437b5e
                                  

                              Returns:

                              Packit 437b5e
                                  
                                Packit 437b5e
                                Packit 437b5e
                                           int
                                Packit 437b5e
                                        0, if successful
                                Packit 437b5e
                                    
                                Packit 437b5e
                                     

                                Or

                                Packit 437b5e
                                    
                                  Packit 437b5e
                                          
                                1. Packit 437b5e
                                          nil
                                  Packit 437b5e
                                          
                                2. Packit 437b5e
                                             string
                                  Packit 437b5e
                                          error message
                                  Packit 437b5e
                                          
                                3. Packit 437b5e
                                             int
                                  Packit 437b5e
                                          errnum
                                  Packit 437b5e
                                      
                                  Packit 437b5e
                                  Packit 437b5e
                                  Packit 437b5e
                                      

                                  See also:

                                  Packit 437b5e
                                      
                                    Packit 437b5e
                                             msgsnd(2)
                                    Packit 437b5e
                                        
                                    Packit 437b5e
                                    Packit 437b5e
                                    Packit 437b5e
                                    Packit 437b5e
                                    Packit 437b5e
                                        

                                    Constants

                                    Packit 437b5e
                                    Packit 437b5e
                                    Packit 437b5e
                                        
                                    Packit 437b5e
                                        
                                    Packit 437b5e
                                        
                                    Packit 437b5e
                                        posix.sys.msg
                                    Packit 437b5e
                                        
                                    Packit 437b5e
                                        
                                    Packit 437b5e
                                        Message constants.
                                    Packit 437b5e
                                    Any constants not available in the underlying system will be nil valued.
                                    Packit 437b5e
                                    Packit 437b5e
                                    Packit 437b5e
                                        

                                    Fields:

                                    Packit 437b5e
                                        
                                      Packit 437b5e
                                              
                                    • IPC_CREAT
                                    • Packit 437b5e
                                                  int
                                      Packit 437b5e
                                               create entry if key does not exist
                                      Packit 437b5e
                                              
                                      Packit 437b5e
                                              
                                    • IPC_EXCL
                                    • Packit 437b5e
                                                  int
                                      Packit 437b5e
                                               fail if key exists
                                      Packit 437b5e
                                              
                                      Packit 437b5e
                                              
                                    • IPC_PRIVATE
                                    • Packit 437b5e
                                                  int
                                      Packit 437b5e
                                               private key
                                      Packit 437b5e
                                              
                                      Packit 437b5e
                                              
                                    • IPC_NOWAIT
                                    • Packit 437b5e
                                                  int
                                      Packit 437b5e
                                               error if request must wait
                                      Packit 437b5e
                                              
                                      Packit 437b5e
                                              
                                    • MSG_EXCEPT
                                    • Packit 437b5e
                                                  int
                                      Packit 437b5e
                                               read messages with differing type
                                      Packit 437b5e
                                              
                                      Packit 437b5e
                                              
                                    • MSG_NOERROR
                                    • Packit 437b5e
                                                  int
                                      Packit 437b5e
                                               truncate received message rather than erroring
                                      Packit 437b5e
                                              
                                      Packit 437b5e
                                          
                                      Packit 437b5e
                                      Packit 437b5e
                                      Packit 437b5e
                                      Packit 437b5e
                                      Packit 437b5e
                                          

                                      Usage:

                                      Packit 437b5e
                                          
                                        Packit 437b5e
                                                
                                        Packit 437b5e
                                          -- Print msg constants supported on this host.
                                        Packit 437b5e
                                          for name, value in pairs (require "posix.sys.msg") do
                                        Packit 437b5e
                                            if type (value) == "number" then
                                        Packit 437b5e
                                              print (name, value)
                                        Packit 437b5e
                                             end
                                        Packit 437b5e
                                          end
                                        Packit 437b5e
                                            
                                        Packit 437b5e
                                        Packit 437b5e
                                        Packit 437b5e
                                        Packit 437b5e
                                        Packit 437b5e
                                        Packit 437b5e
                                         
                                        Packit 437b5e
                                         
                                        Packit 437b5e
                                        Packit 437b5e
                                        generated by LDoc 1.4.3
                                        Packit 437b5e
                                        Last updated 2015-03-01 09:06:02 
                                        Packit 437b5e
                                         
                                        Packit 437b5e
                                         
                                        Packit 437b5e
                                        </body>
                                        Packit 437b5e
                                        </html>