ROBinMessage

Overview

Being a descendant of the abstract message class, this class implements the binary messaging protocol for Xcode.

Location

 

beginReadObjectWithName:asClass:    (declared in ROMessage)

- (ROComplexType *) beginReadObjectWithName:(NSString *)aName asClass:(Class)aClass

Parameters:

  • aName:
  • aClass:

beginWriteObject:withName:    (declared in ROMessage)

- (void) beginWriteObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

channel  retain    (declared in ROMessage)

@property (retain) ROChannel *channel

clear    (declared in ROMessage)

- (void) clear

clearAttributes    (declared in ROMessage)

- (void) clearAttributes

clientID  retain    (declared in ROMessage)

@property (retain) ROGuid *clientID

contentType  retain    (declared in ROMessage)

@property (readonly, retain) NSString *contentType

createExceptionWithClassName:message:    (declared in ROMessage)

- (NSException *) createExceptionWithClassName:(NSString *)aExceptionName message:(NSString *)aMessage

Parameters:

  • aExceptionName:
  • aMessage:

doGetNSData    (declared in ROMessage)

- (NSMutableData *) doGetNSData

doPrepareFromNSData:    (declared in ROMessage)

- (void) doPrepareFromNSData:(NSData *)aData

Parameters:

  • aData:

doRead    (declared in ROMessage)

- (void) doRead

doReadException:    (declared in ROMessage)

- (void) doReadException:(id)aException

Parameters:

  • aException:

doReadObject:withName:    (declared in ROMessage)

- (void) doReadObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

doWriteObject:withName:    (declared in ROMessage)

- (void) doWriteObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

endReadObject:withName:    (declared in ROMessage)

- (void) endReadObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

endWriteObject:withName:    (declared in ROMessage)

- (void) endWriteObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

enforceMaxMessageSize  assign

Reserved for future use.

@property (assign) BOOL enforceMaxMessageSize

envelopes    (declared in ROMessage)

@property (readonly) NSMutableDictionary *envelopes

exception    (declared in ROMessage)

@property (readonly) NSException *exception

finalizeMessage    (declared in ROMessage)

- (void) finalizeMessage

getAtttributeValue:    (declared in ROMessage)

- (NSString *) getAtttributeValue:(NSString *)aName

Parameters:

  • aName:

getNSData    (declared in ROMessage)

- (NSMutableData *) getNSData

initializeAsRequestMessage:libraryName:interfaceName:messageName:    (declared in ROMessage)

- (void) initializeAsRequestMessage:(ROChannel *)aChannel libraryName:(NSString *)aLibraryName interfaceName:(NSString *)anInterfaceName messageName:(NSString *)aMessageName

Parameters:

  • aChannel:
  • aLibraryName:
  • anInterfaceName:
  • aMessageName:

initializeMessage:libraryName:interfaceName:messageName:messageType:    (declared in ROMessage)

- (void) initializeMessage:(ROChannel *)aChannel libraryName:(NSString *)aLibraryName interfaceName:(NSString *)anInterfaceName messageName:(NSString *)aMessageName messageType:(enum ROMessageType)aMessageType

Parameters:

  • aChannel:
  • aLibraryName:
  • anInterfaceName:
  • aMessageName:
  • aMessageType:

interfaceName  copy    (declared in ROMessage)

@property (copy) NSString *interfaceName

libraryName  copy    (declared in ROMessage)

@property (copy) NSString *libraryName

maxMessageSize  assign

Reserved for future use.

@property (assign) long maxMessageSize

message    (declared in ROMessage)

Creates and returns a new instance of the message class.

+ (id) message

messageMatchingTargetURL:    (declared in ROMessage)

+ (id) messageMatchingTargetURL:(NSURL *)targetUrl

Parameters:

  • targetUrl:

messageName  copy    (declared in ROMessage)

@property (copy) NSString *messageName

messageType    (declared in ROMessage)

@property (readonly) enum ROMessageType messageType

minSizeForCompression  assign

Specifies the minimum overall message data length to turn message compression on (if enabled with the useCompression property). Compressing small amounts of data does not give much size reduction but leads to a higher CPU load so it might be advantageous to limit the compressible data size. The default minimum size for ZLib compression algorithm is 4096 bytes. We recommend to keep the default value of the property.

@property (assign) long minSizeForCompression

prepareFromNSData:    (declared in ROMessage)

- (void) prepareFromNSData:(NSData *)aData

Parameters:

  • aData:

processException    (declared in ROMessage)

- (void) processException

read    (declared in ROMessage)

- (void) read

readAnsiString    (declared in ROMessage)

- (NSString *) readAnsiString

readAnsiStringWithName:    (declared in ROMessage)

- (NSString *) readAnsiStringWithName:(NSString *)aName

Parameters:

  • aName:

readByte    (declared in ROMessage)

- (unsigned char) readByte

readException    (declared in ROMessage)

- (NSException *) readException

readFromNSData:    (declared in ROMessage)

- (void) readFromNSData:(NSData *)aData

Parameters:

  • aData:

readUtf8String    (declared in ROMessage)

- (NSString *) readUtf8String

readUtf8StringWithName:    (declared in ROMessage)

- (NSString *) readUtf8StringWithName:(NSString *)aName

Parameters:

  • aName:

readWideString    (declared in ROMessage)

- (NSString *) readWideString

readWideStringWithName:    (declared in ROMessage)

- (NSString *) readWideStringWithName:(NSString *)aName

Parameters:

  • aName:

setupAttributes:    (declared in ROMessage)

- (void) setupAttributes:(NSDictionary *)aAttributes

Parameters:

  • aAttributes:

setUseSingleClientID:    (declared in ROMessage)

+ (void) setUseSingleClientID:(BOOL)flag

Parameters:

  • flag:

useCompression  assign

Allows to turn message compression on (default) or off. You may consider to turn the compression off, if you either expect the data to be incompressible or if you want to keep CPU load at a minimum. The compression for the concrete message will be turned off automatically if it's length is less than the value of the minSizeForCompression property.

@property (assign) BOOL useCompression

useSingleClientID    (declared in ROMessage)

+ (BOOL) useSingleClientID

useStrictFieldOrderForStructs    (declared in ROMessage)

- (BOOL) useStrictFieldOrderForStructs

writeToNSData:    (declared in ROMessage)

- (void) writeToNSData:(NSMutableData *)aData

Parameters:

  • aData:

 

channel  retain    (declared in ROMessage)

@property (retain) ROChannel *channel

clientID  retain    (declared in ROMessage)

@property (retain) ROGuid *clientID

contentType  retain    (declared in ROMessage)

@property (readonly, retain) NSString *contentType

enforceMaxMessageSize  assign

Reserved for future use.

@property (assign) BOOL enforceMaxMessageSize

envelopes    (declared in ROMessage)

@property (readonly) NSMutableDictionary *envelopes

exception    (declared in ROMessage)

@property (readonly) NSException *exception

interfaceName  copy    (declared in ROMessage)

@property (copy) NSString *interfaceName

libraryName  copy    (declared in ROMessage)

@property (copy) NSString *libraryName

maxMessageSize  assign

Reserved for future use.

@property (assign) long maxMessageSize

messageName  copy    (declared in ROMessage)

@property (copy) NSString *messageName

messageType    (declared in ROMessage)

@property (readonly) enum ROMessageType messageType

minSizeForCompression  assign

Specifies the minimum overall message data length to turn message compression on (if enabled with the useCompression property). Compressing small amounts of data does not give much size reduction but leads to a higher CPU load so it might be advantageous to limit the compressible data size. The default minimum size for ZLib compression algorithm is 4096 bytes. We recommend to keep the default value of the property.

@property (assign) long minSizeForCompression

useCompression  assign

Allows to turn message compression on (default) or off. You may consider to turn the compression off, if you either expect the data to be incompressible or if you want to keep CPU load at a minimum. The compression for the concrete message will be turned off automatically if it's length is less than the value of the minSizeForCompression property.

@property (assign) BOOL useCompression

 

message    (declared in ROMessage)

Creates and returns a new instance of the message class.

+ (id) message

messageMatchingTargetURL:    (declared in ROMessage)

+ (id) messageMatchingTargetURL:(NSURL *)targetUrl

Parameters:

  • targetUrl:

setUseSingleClientID:    (declared in ROMessage)

+ (void) setUseSingleClientID:(BOOL)flag

Parameters:

  • flag:

useSingleClientID    (declared in ROMessage)

+ (BOOL) useSingleClientID

 

beginReadObjectWithName:asClass:    (declared in ROMessage)

- (ROComplexType *) beginReadObjectWithName:(NSString *)aName asClass:(Class)aClass

Parameters:

  • aName:
  • aClass:

beginWriteObject:withName:    (declared in ROMessage)

- (void) beginWriteObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

clear    (declared in ROMessage)

- (void) clear

clearAttributes    (declared in ROMessage)

- (void) clearAttributes

createExceptionWithClassName:message:    (declared in ROMessage)

- (NSException *) createExceptionWithClassName:(NSString *)aExceptionName message:(NSString *)aMessage

Parameters:

  • aExceptionName:
  • aMessage:

doGetNSData    (declared in ROMessage)

- (NSMutableData *) doGetNSData

doPrepareFromNSData:    (declared in ROMessage)

- (void) doPrepareFromNSData:(NSData *)aData

Parameters:

  • aData:

doRead    (declared in ROMessage)

- (void) doRead

doReadException:    (declared in ROMessage)

- (void) doReadException:(id)aException

Parameters:

  • aException:

doReadObject:withName:    (declared in ROMessage)

- (void) doReadObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

doWriteObject:withName:    (declared in ROMessage)

- (void) doWriteObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

endReadObject:withName:    (declared in ROMessage)

- (void) endReadObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

endWriteObject:withName:    (declared in ROMessage)

- (void) endWriteObject:(ROComplexType *)anObject withName:(NSString *)aName

Parameters:

  • anObject:
  • aName:

finalizeMessage    (declared in ROMessage)

- (void) finalizeMessage

getAtttributeValue:    (declared in ROMessage)

- (NSString *) getAtttributeValue:(NSString *)aName

Parameters:

  • aName:

getNSData    (declared in ROMessage)

- (NSMutableData *) getNSData

initializeAsRequestMessage:libraryName:interfaceName:messageName:    (declared in ROMessage)

- (void) initializeAsRequestMessage:(ROChannel *)aChannel libraryName:(NSString *)aLibraryName interfaceName:(NSString *)anInterfaceName messageName:(NSString *)aMessageName

Parameters:

  • aChannel:
  • aLibraryName:
  • anInterfaceName:
  • aMessageName:

initializeMessage:libraryName:interfaceName:messageName:messageType:    (declared in ROMessage)

- (void) initializeMessage:(ROChannel *)aChannel libraryName:(NSString *)aLibraryName interfaceName:(NSString *)anInterfaceName messageName:(NSString *)aMessageName messageType:(enum ROMessageType)aMessageType

Parameters:

  • aChannel:
  • aLibraryName:
  • anInterfaceName:
  • aMessageName:
  • aMessageType:

prepareFromNSData:    (declared in ROMessage)

- (void) prepareFromNSData:(NSData *)aData

Parameters:

  • aData:

processException    (declared in ROMessage)

- (void) processException

read    (declared in ROMessage)

- (void) read

readAnsiString    (declared in ROMessage)

- (NSString *) readAnsiString

readAnsiStringWithName:    (declared in ROMessage)

- (NSString *) readAnsiStringWithName:(NSString *)aName

Parameters:

  • aName:

readByte    (declared in ROMessage)

- (unsigned char) readByte

readException    (declared in ROMessage)

- (NSException *) readException

readFromNSData:    (declared in ROMessage)

- (void) readFromNSData:(NSData *)aData

Parameters:

  • aData:

readUtf8String    (declared in ROMessage)

- (NSString *) readUtf8String

readUtf8StringWithName:    (declared in ROMessage)

- (NSString *) readUtf8StringWithName:(NSString *)aName

Parameters:

  • aName:

readWideString    (declared in ROMessage)

- (NSString *) readWideString

readWideStringWithName:    (declared in ROMessage)

- (NSString *) readWideStringWithName:(NSString *)aName

Parameters:

  • aName:

setupAttributes:    (declared in ROMessage)

- (void) setupAttributes:(NSDictionary *)aAttributes

Parameters:

  • aAttributes:

useStrictFieldOrderForStructs    (declared in ROMessage)

- (BOOL) useStrictFieldOrderForStructs

writeToNSData:    (declared in ROMessage)

- (void) writeToNSData:(NSMutableData *)aData

Parameters:

  • aData:

See Also