Package com.couchbase.lite

Class MessageEndpoint

java.lang.Object

com.couchbase.lite.MessageEndpoint

All Implemented Interfaces:

Endpoint

public class MessageEndpoint
extends Object
implements Endpoint

ENTERPRISE EDITION API

Replication Message endpoint.

Constructor Summary

Constructors

Constructor	Description
MessageEndpoint(String uid, Object target, ProtocolType protocolType, MessageEndpointDelegate delegate)	Initializes a CBLMessageEndpoint object.

Method Summary

Modifier and Type	Method	Description
MessageEndpointDelegate	getDelegate()	Gets the delegate object used for creating MessageEndpointConnection objects.
com.couchbase.lite.internal.sockets.MessageFraming	getMessageFraming()
ProtocolType	getProtocolType()	Gets the data transportation protocol of the endpoint.
Object	getTarget()	Gets the target object which is an arbitrary object that represents the endpoint.
String	getUid()	Gets the unique identifier of the endpoint.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageEndpoint

public MessageEndpoint(@NonNull
                       String uid,
                       @Nullable
                       Object target,
                       @NonNull
                       ProtocolType protocolType,
                       @NonNull
                       MessageEndpointDelegate delegate)

Initializes a CBLMessageEndpoint object.

Parameters:

uid - the unique identifier of the endpoint

target - an optional arbitrary object that represents the endpoint

protocolType - the data transportation protocol

delegate - the delegate for creating MessageEndpointConnection objects

Method Detail

getUid

@NonNull
public String getUid()

Gets the unique identifier of the endpoint.

Returns:

the unique identifier of the endpoint

getTarget

@Nullable
public Object getTarget()

Gets the target object which is an arbitrary object that represents the endpoint.

Returns:

the target object.

getProtocolType

@NonNull
public ProtocolType getProtocolType()

Gets the data transportation protocol of the endpoint.

Returns:

the data transportation protocol

getDelegate

@NonNull
public MessageEndpointDelegate getDelegate()

Gets the delegate object used for creating MessageEndpointConnection objects.

Returns:

the delegate object.

toString

@NonNull
public String toString()

Overrides:

toString in class Object

getMessageFraming

@Internal("This method is not part of the public API: it is for internal use only")
@NonNull
public com.couchbase.lite.internal.sockets.MessageFraming getMessageFraming()