niryo_libraries.rospy.impl.tcpros_service.TCPROSServiceClient

class documentation

class TCPROSServiceClient(TCPROSTransportProtocol):

Constructor: TCPROSServiceClient(resolved_name, service_class, headers, buff_size)

View In Hierarchy

Protocol Implementation for Service clients over TCPROS

Method __init__ ctor. @param resolved_name: resolved service name @type resolved_name: str @param service_class: Service data type class @type service_class: Service @param headers: identifier for Service session @type headers: dict @param buff_size: size of buffer (bytes) for reading responses from Service...
Method get_header_fields TCPROSTransportProtocol API
Method read_messages In service implementation, reads in OK byte that precedes each response. The OK byte allows for the passing of error messages instead of a response message @param b: buffer @type b: StringIO @param msg_queue: Message queue to append to @type msg_queue: [Message] @param sock: socket to read from @type sock: socket...
Instance Variable buff_size Undocumented
Instance Variable headers Undocumented
Instance Variable service_class Undocumented
Method _read_ok_byte Utility for reading the OK-byte/error-message header preceding each message. @param sock: socket connection. Will be read from if OK byte is false and error message needs to be read @type sock: socket...
Method _read_service_error Read service error from sock @param sock: socket to read from @type sock: socket @param b: currently read data from sock @type b: StringIO
def __init__(self, resolved_name, service_class, headers=None, buff_size=DEFAULT_BUFF_SIZE):

ctor. @param resolved_name: resolved service name @type resolved_name: str @param service_class: Service data type class @type service_class: Service @param headers: identifier for Service session @type headers: dict @param buff_size: size of buffer (bytes) for reading responses from Service. @type buff_size: int

def get_header_fields(self):

TCPROSTransportProtocol API

def read_messages(self, b, msg_queue, sock):

In service implementation, reads in OK byte that precedes each response. The OK byte allows for the passing of error messages instead of a response message @param b: buffer @type b: StringIO @param msg_queue: Message queue to append to @type msg_queue: [Message] @param sock: socket to read from @type sock: socket.socket

buff_size =

Undocumented

headers =

Undocumented

service_class =

Undocumented

def _read_ok_byte(self, b, sock):

Utility for reading the OK-byte/error-message header preceding each message. @param sock: socket connection. Will be read from if OK byte is false and error message needs to be read @type sock: socket.socket @param b: buffer to read from @type b: StringIO

def _read_service_error(self, sock, b):

Read service error from sock @param sock: socket to read from @type sock: socket @param b: currently read data from sock @type b: StringIO