Class Rice::ICEMachine |
|
ICEMachines are either syndicators or subscribers. The methods here implement common behaviors such as pinging, returning a ping response, creating error responses, and retreiving error codes from payloads.
Methods |
Attributes |
:domain | [R] | |
:party | [R] |
Public Class methods |
new(domain, uuid, name, role) |
Public Instance methods |
uuid() |
name() |
role() |
error(errorCode, requestId, errorMessage = nil) |
Returns an XML payload containing the specified error message. The error phrase is filled in by Rice::ErrorPayload.
ping(url) |
Request, receive, and return a ping from the specified url (presumably another ICEMachine). "url" may be either a string or a URL object.
sendPayload(payload, url) |
Send a payload and return the body of the reply. "url" may be either a string or a URL object.
retrieveErrorCodeFrom(reply, requestId) |
Returns the error code and text in the specified reply.
pingResponse(requestId) |
Returns the most common ping response: an ice-nop response.
sendConfirmation(requestId, url) |
Send a confirmation back to the other party "url" may be either a string or a URL object.