io.textile.textile

Class Ipfs

java.lang.Object

io.textile.textile.Ipfs

public class Ipfs
extends java.lang.Object

Provides access to Textile IPFS related APIs

Method Summary

Modifier and Type	Method and Description
void	cancelPubsubSub(java.lang.String queryId) Cancel subscribe to messages on a given topic
void	dataAtPath(java.lang.String path, Handlers.DataHandler handler) Get raw data stored at an IPFS path
java.lang.String	peerId() Fetch the IPFS peer id
void	pubsubPub(java.lang.String topic, java.lang.String data) Publishes a message to a given pubsub topic
java.lang.String	pubsubSub(java.lang.String topic) Subscribes to messages on a given topic
java.lang.Boolean	swarmConnect(java.lang.String multiaddr) Open a new direct connection to a peer using an IPFS multiaddr

Methods inherited from class java.lang.Object

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

Method Detail

peerId

public java.lang.String peerId()
                        throws java.lang.Exception

Fetch the IPFS peer id

Returns:

The IPFS peer id of the local Textile node

Throws:

java.lang.Exception - The exception that occurred

swarmConnect

public java.lang.Boolean swarmConnect(java.lang.String multiaddr)
                               throws java.lang.Exception

Open a new direct connection to a peer using an IPFS multiaddr

Parameters:

multiaddr - Peer IPFS multiaddr

Returns:

Whether the peer swarm connect was successfull

Throws:

java.lang.Exception - The exception that occurred

dataAtPath

public void dataAtPath(java.lang.String path,
                       Handlers.DataHandler handler)

Get raw data stored at an IPFS path

Parameters:

path - The IPFS path for the data you want to retrieve

handler - An object that will get called with the resulting data and media type

pubsubPub

public void pubsubPub(java.lang.String topic,
                      java.lang.String data)
               throws java.lang.Exception

Publishes a message to a given pubsub topic

Parameters:

topic - The topic to publish to

data - The payload of message to publish

Throws:

java.lang.Exception - The exception that occurred

pubsubSub

public java.lang.String pubsubSub(java.lang.String topic)
                           throws java.lang.Exception

Subscribes to messages on a given topic

Parameters:

topic - The ipfs pubsub sub topic

Returns:

A query ID that can be used to cancel the sub

Throws:

java.lang.Exception - The exception that occurred

cancelPubsubSub

public void cancelPubsubSub(java.lang.String queryId)
                     throws java.lang.Exception

Cancel subscribe to messages on a given topic

Parameters:

queryId - The query ID that can be used to cancel the sub

Throws:

java.lang.Exception - The exception that occurred