ROMessage Class

From RemObjects Wiki

Jump to:navigation, search
Xcode Platform Header-48.png

This is a RemObjects SDK for Xcode Library topic

Please do not modify the page structure, but feel free to modify/add text.

Classes — Protocols — Enums

Contents

Overview

ROMessage is the abstract base class for Message implementations in RemObjects SDK for Xcode.

You will usually not instantiate instances of this class itself, but use the descendant classes such as ROBinMessage.


Location

RemObjectsSDK/RemObjectsSDK.h


Properties

channel   retain


@property (retain) ROChannel *channel

Contains the Client ID for the message. Client IDs are used by the RemObjects SDK for Session Management and to uniquely identify individual client on the server.

Generally, you will not need to assign or read this value; the framework will automatically create a new unique client ID whenever a message object is instantiated on the client. However, you do have the option to read and write the ClientID property manually, for example to persist a specific client ID between shutdown and restart of your application.

clientID   retain


@property (retain) ROGuid *clientID

contentType   readonly retain


@property (readonly,retain) NSString *contentType

A collection of optional Message Envelopes configured for this message.

envelopes   readonly


@property (readonly) NSMutableDictionary *envelopes

interfaceName   copy


@property (copy) NSString *interfaceName

libraryName   copy


@property (copy) NSString *libraryName

messageName   copy


@property (copy) NSString *messageName

messageType   readonly


@property (readonly) enum ROMessageType messageType


Class Methods

message

Creates and returns a new instance of the message class.


+ (id) message

setUseSingleClientID:


+ (void) setUseSingleClientID:(BOOL)flag
Parameters:

  • flag:


useSingleClientID


+ (BOOL) useSingleClientID


Instance Methods

beginReadObjectWithName:asClass:


- (ROComplexType *) beginReadObjectWithName:(NSString *)aName asClass:(Class)class
Parameters:

  • aName:
  • class:


beginWriteObject:withName:


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

  • anObject:
  • aName:


clear


- (void) clear

clearAttributes


- (void) clearAttributes

createExceptionWithClassName:message:


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

  • aExceptionName:
  • aMessage:


doGetNSData


- (NSMutableData *) doGetNSData

doReadException:


- (void) doReadException:(id)aException
Parameters:

  • aException:


doReadFromNSData:


- (int) doReadFromNSData:(NSData *)aData
Parameters:

  • aData:


doReadObject:withName:


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

  • anObject:
  • aName:


doWriteObject:withName:


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

  • anObject:
  • aName:


endReadObject:withName:


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

  • anObject:
  • aName:


endWriteObject:withName:


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

  • anObject:
  • aName:


finalizeMessage


- (void) finalizeMessage

getAtttributeValue:


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

  • aName:


getNSData


- (NSMutableData *) getNSData

initializeAsRequestMessage:libraryName:interfaceName:messageName:


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

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


initializeMessage:libraryName:interfaceName:messageName:messageType:


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

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


processException


- (void) processException

readAnsiString


- (NSString *) readAnsiString

readAnsiStringWithName:


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

  • aName:


readByte


- (unsigned char) readByte

readException


- (NSException *) readException

readFromNSData:


- (int) readFromNSData:(NSData *)aData
Parameters:

  • aData:


readUtf8String


- (NSString *) readUtf8String

readUtf8StringWithName:


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

  • aName:


readWideString


- (NSString *) readWideString

readWideStringWithName:


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

  • aName:


setupAttributes:


- (void) setupAttributes:(NSDictionary *)aAttributes
Parameters:

  • aAttributes:


useStrictFieldOrderForStructs


- (BOOL) useStrictFieldOrderForStructs

writeToNSData:


- (void) writeToNSData:(NSMutableData *)aData
Parameters:

  • aData:



See Also


Ro-48.png

Product: RemObjects SDK
Available Editions: RemObjects SDK for .NET, Delphi and Xcode

Glossary — Architecture — Articles — Features — Library — Samples

Retrieved from "http://wiki.remobjects.com/wiki/ROMessage_Class"
Navigation
products
hubs
special
Toolbox