rosbridge_server.tcp_handler.RosbridgeTcpSocket Class Reference

Inheritance diagram for rosbridge_server.tcp_handler.RosbridgeTcpSocket:

Public Member Functions
def	finish (self)
def	handle (self)
def	recv_bson (self)
def	recvall (self, n)
def	send_message (self, message=None, compression="none")
def	setup (self)

Public Attributes
	protocol

Static Public Attributes
bool	bson_only_mode = False
bool	busy = False
	client_count_pub = None
int	client_id_seed = 0
int	clients_connected = 0
int	delay_between_messages = 0
int	fragment_timeout = 600
int	incoming_buffer = 65536
	max_message_size = None
list	queue = []
int	socket_timeout = 10
float	unregister_timeout = 10.0

Detailed Description

TCP Socket server for rosbridge.
An instance of this class is created for each request.

Definition at line 10 of file tcp_handler.py.

Member Function Documentation

finish()

def rosbridge_server.tcp_handler.RosbridgeTcpSocket.finish

(

self

)

Called when TCP connection finishes.
Called after the handle() method to perform any clean-up actions required.
If setup() raises an exception, this function will not be called.

Definition at line 120 of file tcp_handler.py.

handle()

def rosbridge_server.tcp_handler.RosbridgeTcpSocket.handle

(

self

)

Listen for TCP messages and do all the work to service a request.

Definition at line 92 of file tcp_handler.py.

recv_bson()

def rosbridge_server.tcp_handler.RosbridgeTcpSocket.recv_bson

(

self

)

Definition at line 70 of file tcp_handler.py.

recvall()

def rosbridge_server.tcp_handler.RosbridgeTcpSocket.recvall	(		self,
			n
	)

Definition at line 59 of file tcp_handler.py.

send_message()

def rosbridge_server.tcp_handler.RosbridgeTcpSocket.send_message	(		self,
			message = None,
			compression = "none"
	)

Callback from rosbridge

Definition at line 133 of file tcp_handler.py.

setup()

def rosbridge_server.tcp_handler.RosbridgeTcpSocket.setup

(

self

)

Called before the handle() method to perform any initialization
actions required. The default implementation does nothing.

Definition at line 34 of file tcp_handler.py.

Member Data Documentation

bson_only_mode

bool rosbridge_server.tcp_handler.RosbridgeTcpSocket.bson_only_mode = False

static

Definition at line 32 of file tcp_handler.py.

busy

bool rosbridge_server.tcp_handler.RosbridgeTcpSocket.busy = False

static

Definition at line 16 of file tcp_handler.py.

client_count_pub

rosbridge_server.tcp_handler.RosbridgeTcpSocket.client_count_pub = None

static

Definition at line 20 of file tcp_handler.py.

client_id_seed

int rosbridge_server.tcp_handler.RosbridgeTcpSocket.client_id_seed = 0

static

Definition at line 18 of file tcp_handler.py.

clients_connected

int rosbridge_server.tcp_handler.RosbridgeTcpSocket.clients_connected = 0

static

Definition at line 19 of file tcp_handler.py.

delay_between_messages

int rosbridge_server.tcp_handler.RosbridgeTcpSocket.delay_between_messages = 0

static

Definition at line 29 of file tcp_handler.py.

fragment_timeout

int rosbridge_server.tcp_handler.RosbridgeTcpSocket.fragment_timeout = 600

static

Definition at line 27 of file tcp_handler.py.

incoming_buffer

int rosbridge_server.tcp_handler.RosbridgeTcpSocket.incoming_buffer = 65536

static

Definition at line 23 of file tcp_handler.py.

max_message_size

rosbridge_server.tcp_handler.RosbridgeTcpSocket.max_message_size = None

static

Definition at line 30 of file tcp_handler.py.

protocol

rosbridge_server.tcp_handler.RosbridgeTcpSocket.protocol

Definition at line 49 of file tcp_handler.py.

queue

list rosbridge_server.tcp_handler.RosbridgeTcpSocket.queue = []

static

Definition at line 17 of file tcp_handler.py.

socket_timeout

int rosbridge_server.tcp_handler.RosbridgeTcpSocket.socket_timeout = 10

static

Definition at line 24 of file tcp_handler.py.

unregister_timeout

float rosbridge_server.tcp_handler.RosbridgeTcpSocket.unregister_timeout = 10.0

static

Definition at line 31 of file tcp_handler.py.

---

The documentation for this class was generated from the following file:

• tcp_handler.py