Inheritance diagram for upload.AbstractRpcServer:

Public Member Functions
def	__init__ (self, host, auth_function, host_override=None, extra_headers={}, save_cookies=False)

def	Send (self, request_path, payload=None, content_type="application/octet-stream", timeout=None, kwargs)

def	__init__ (self, host, auth_function, host_override=None, extra_headers={}, save_cookies=False)

def	Send (self, request_path, payload=None, content_type="application/octet-stream", timeout=None, kwargs)

Public Attributes
	host

	host_override

	auth_function

	authenticated

	extra_headers

	save_cookies

	opener

Detailed Description

Provides a common interface for a simple RPC server.

Constructor & Destructor Documentation

def upload.AbstractRpcServer.__init__	(	self,
		host,
		auth_function,
		host_override = `None`,
		extra_headers = `{}`,
		save_cookies = `False`
	)

Creates a new HttpRpcServer.

Args:
  host: The host to send requests to.
  auth_function: A function that takes no arguments and returns an
(email, password) tuple when called. Will be called if authentication
is required.
  host_override: The host header to send to the server (defaults to host).
  extra_headers: A dict of extra headers to append to every request.
  save_cookies: If True, save the authentication cookies to local disk.
If False, use an in-memory cookiejar instead.  Subclasses must
implement this functionality.  Defaults to False.

def upload.AbstractRpcServer.__init__	(	self,
		host,
		auth_function,
		host_override = `None`,
		extra_headers = `{}`,
		save_cookies = `False`
	)

Creates a new HttpRpcServer.

Args:
  host: The host to send requests to.
  auth_function: A function that takes no arguments and returns an
(email, password) tuple when called. Will be called if authentication
is required.
  host_override: The host header to send to the server (defaults to host).
  extra_headers: A dict of extra headers to append to every request.
  save_cookies: If True, save the authentication cookies to local disk.
If False, use an in-memory cookiejar instead.  Subclasses must
implement this functionality.  Defaults to False.

References upload.AbstractRpcServer._CreateRequest(), upload.AbstractRpcServer._GetAuthCookie(), upload.AbstractRpcServer._GetAuthToken(), upload.AbstractRpcServer._GetOpener(), upload.AbstractRpcServer.auth_function, upload.AbstractRpcServer.authenticated, upload.AbstractRpcServer.extra_headers, upload.AbstractRpcServer.host, upload.AbstractRpcServer.host_override, upload.AbstractRpcServer.opener, upload.AbstractRpcServer.save_cookies, and upload.AbstractRpcServer.Send().

Member Function Documentation

def upload.AbstractRpcServer.Send	(	self,
		request_path,
		payload = `None`,
		content_type = `"application/octet-stream"`,
		timeout = `None`,
		kwargs
	)

Sends an RPC and returns the response.

Args:
  request_path: The path to send the request to, eg /api/appversion/create.
  payload: The body of the request, or None to send an empty request.
  content_type: The Content-Type header to use.
  timeout: timeout in seconds; default None i.e. no timeout.
(Note: for large requests on OS X, the timeout doesn't work right.)
  kwargs: Any keyword arguments are converted into query string parameters.

Returns:
  The response body, as a string.

References upload.AbstractRpcServer._Authenticate(), upload.AbstractRpcServer._CreateRequest(), upload.AbstractRpcServer.authenticated, and upload.AbstractRpcServer.host.

Referenced by upload.AbstractRpcServer.__init__().

def upload.AbstractRpcServer.Send	(	self,
		request_path,
		payload = `None`,
		content_type = `"application/octet-stream"`,
		timeout = `None`,
		kwargs
	)

Sends an RPC and returns the response.

Args:
  request_path: The path to send the request to, eg /api/appversion/create.
  payload: The body of the request, or None to send an empty request.
  content_type: The Content-Type header to use.
  timeout: timeout in seconds; default None i.e. no timeout.
(Note: for large requests on OS X, the timeout doesn't work right.)
  kwargs: Any keyword arguments are converted into query string parameters.

Returns:
  The response body, as a string.

References upload.AbstractRpcServer._Authenticate(), upload.AbstractRpcServer._CreateRequest(), upload.AbstractRpcServer.authenticated, upload.HttpRpcServer.cookie_file, upload.HttpRpcServer.cookie_jar, upload.EncodeMultipartFormData(), upload.ErrorExit(), upload.GetContentType(), upload.GetEmail(), upload.GetRpcServer(), upload.AbstractRpcServer.host, upload.RunShell(), upload.RunShellWithReturnCode(), upload.AbstractRpcServer.save_cookies, and upload.StatusUpdate().