API Reference for Enthought Tool Suite 3.2.0

serve_tcp(...)
serve_udp(...)

from enthought.mayavi import mlab
from enthought.mayavi.tools import server
mlab.test_plot3d()
server.serve_tcp()

$ telnet localhost 8007
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
scene.camera.azimuth(45)
mlab.clf()
mlab.test_contour3d()
scene.camera.zoom(1.5)

Classes

• M2TCP - Implements a brain dead but suprememly powerful TCP API
• M2UDP - Implements a brain dead but supremely powerful UDP API

Function summary

• serve_tcp(engine = None, port = 8007, logto = sys.stdout, max_connect = 1)
• serve_udp(engine = None, port = 9007, logto = sys.stdout)
• test_tcp()
• test_udp()

Functions

• serve_tcp(engine = None, port = 8007, logto = sys.stdout, max_connect = 1)

  Serve the M2TCP protocol using the given engine on the specified port logging messages to given logto which is a file-like object. This function will block till the service is closed. There is no need to call mlab.show() after or before this. The Mayavi UI will be fully responsive.

  Parameters

  engine:	Mayavi engine to use. If this is None, mlab.get_engine() is used to find an appropriate engine.
  port:	int: port to serve on.
  logto:	file: File like object to log messages to. If this is None it disables logging.
  max_connect:	int: Maximum number of simulataneous connections to support.

  Examples

  Here is a very simple example:

  from enthought.mayavi import mlab
  from enthought.mayavi.tools import server
  mlab.test_plot3d()
  server.serve_tcp()
  

  The TCP server will listen on port 8007 by default in the above. Any data sent to the server is simply exec'd, meaning you can do pretty much anything you want. The engine, scene, camera and mlab are all available and can be used. For example after running the above you can do this:

  $ telnet localhost 8007
  Trying 127.0.0.1...
  Connected to localhost.
  Escape character is '^]'.
  scene.camera.azimuth(45)
  mlab.clf()
  mlab.test_contour3d()
  scene.camera.zoom(1.5)
  

  Warning

  Data sent is exec'd so this is a security hole.

• serve_udp(engine = None, port = 9007, logto = sys.stdout)

  Serve the M2UDP protocol using the given engine on the specified port logging messages to given logto which is a file-like object. This function will block till the service is closed. There is no need to call mlab.show() after or before this. The Mayavi UI will be fully responsive.

  Parameters

  engine:	Mayavi engine to use. If this is None, mlab.get_engine() is used to find an appropriate engine.
  port:	int: port to serve on.
  logto:	file : File like object to log messages to. If this is None it disables logging.

  Examples

  Here is a very simple example:

  from enthought.mayavi import mlab
  from enthought.mayavi.tools import server
  mlab.test_plot3d()
  server.serve_udp()
  

  Test it like so:

  import socket
  s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
  s.bind(('', 9008))
  s.sendto('camera.azimuth(10)', ('', 9007))
  

  Warning

  Data sent is exec'd so this is a security hole.

• test_tcp()

  Simple test for the TCP server.

• test_udp()

  Simple test for the UDP server.

Imported Names

© Copyright 2002-2009 Enthought, Inc.