upstream/mercurial-mirror Files · hgext/inotify/common.py

extensions: improve the consistency of synopses...

extensions: improve the consistency of synopses Trying as much as possible to consistently: - use a present tense predicate followed by a direct object - verb referring directly to the functionality provided (ie. not "add command that does this" but simple "do that") - keep simple and to the point, leaving details for the long help (width is tight, possibly even more so for translations) Thanks to timeless, Martin Geisler, Rafael Villar Burke, Dan Villiom Podlaski Christiansen and others for the helpful suggestions.

Nicolas Dumazet - - Load All Authors

File last commit:

r8555:3e09bc5f default


                r8894:868670db

default

Download file

             common.py
        
                    51 lines
            
             | 1.4 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / hgext / inotify / common.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # server.py - inotify common protocol code

      #

      # Copyright 2006, 2007, 2008 Bryan O'Sullivan <bos@serpentine.com>

      # Copyright 2007, 2008 Brendan Cully <brendan@kublai.com>

      #

      # This software may be used and distributed according to the terms of the

      # GNU General Public License version 2, incorporated herein by reference.

      import cStringIO, socket, struct

      """

        Protocol between inotify clients and server:

        Client sending query:

        1) send protocol version number

        2) send query type (string, 4 letters long)

        3) send query parameters:

           - For STAT, N+1 \0-separated strings:

              1) N different names that need checking

              2) 1 string containing all the status types to match

           - No parameter needed for DBUG

        Server sending query answer:

        1) send protocol version number

        2) send query type

        3) send struct.pack'ed headers describing the length of the content:

            e.g. for STAT, receive 8 integers describing the length of the

            8 \0-separated string lists ( one list for each lmar!?ic status type )

      """

      version = 2

      resphdrfmts = {

          'STAT': '>llllllll', # status requests

          'DBUG': '>l'         # debugging queries

      }

      resphdrsizes = dict((k, struct.calcsize(v))

                          for k, v in resphdrfmts.iteritems())

      def recvcs(sock):

          cs = cStringIO.StringIO()

          s = True

          try:

              while s:

                  s = sock.recv(65536)

                  cs.write(s)

          finally:

              sock.shutdown(socket.SHUT_RD)

          cs.seek(0)

          return cs

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				# server.py - inotify common protocol code
				#
				# Copyright 2006, 2007, 2008 Bryan O'Sullivan <bos@serpentine.com>
				# Copyright 2007, 2008 Brendan Cully <brendan@kublai.com>
				#
				# This software may be used and distributed according to the terms of the
				# GNU General Public License version 2, incorporated herein by reference.

				import cStringIO, socket, struct

				"""
				Protocol between inotify clients and server:

				Client sending query:
				1) send protocol version number
				2) send query type (string, 4 letters long)
				3) send query parameters:
				- For STAT, N+1 \0-separated strings:
				1) N different names that need checking
				2) 1 string containing all the status types to match
				- No parameter needed for DBUG

				Server sending query answer:
				1) send protocol version number
				2) send query type
				3) send struct.pack'ed headers describing the length of the content:
				e.g. for STAT, receive 8 integers describing the length of the
				8 \0-separated string lists ( one list for each lmar!?ic status type )

				"""

				version = 2

				resphdrfmts = {
				'STAT': '>llllllll', # status requests
				'DBUG': '>l' # debugging queries
				}
				resphdrsizes = dict((k, struct.calcsize(v))
				for k, v in resphdrfmts.iteritems())

				def recvcs(sock):
				cs = cStringIO.StringIO()
				s = True
				try:
				while s:
				s = sock.recv(65536)
				cs.write(s)
				finally:
				sock.shutdown(socket.SHUT_RD)
				cs.seek(0)
				return cs